Skip to content

Commit 1fcd3ad

Browse files
committed
update readme to show required and optional params
1 parent 7a7d851 commit 1fcd3ad

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,19 @@ This widget is hosted via GitHub Pages, meaning all you need to do is include an
1818
allowtransparency="true" frameborder="0" scrolling="no" width="502px" height="252px"></iframe>
1919
```
2020

21-
### Required Params
21+
### Parameters
2222

2323
`username`<br>
24-
GitHub username that owns the repo<br>
24+
GitHub username that owns the repo (required)<br>
2525

2626
`repo`<br>
27-
GitHub repository to check for activity
27+
GitHub repository to check for activity (required)
2828

2929
`branch`<br>
30-
Branch to use instead of master
30+
Branch to pull commits from (default: master)
3131

3232
`limit`<br>
33-
The maximum number of results to list
33+
The maximum number of results to list (default: 10)
3434

3535

3636
Things to Note

0 commit comments

Comments
 (0)