Skip to content

Commit 96e6d18

Browse files
committed
Added documentation for all repos functionality
1 parent ef6585f commit 96e6d18

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,16 @@ And that's it \o/
3333

3434
[Check full example's source code](https://github.com/zenorocha/jquery-github/blob/master/demo/index.html).
3535

36+
## Extra
37+
38+
Added functionality to fetch and display all repos for a user, to do so just call the plugin on the container and pass it a github username as part of its options object:
39+
40+
```javascript
41+
$('.container').github( { username: 'timdouglas' } );
42+
```
43+
44+
This will create all the divs automatically for you, if you want to give them extra classes, pass the elClass option with the username.
45+
3646
## Showcase
3747

3848
* [zenorocha.com/projects](http://zenorocha.com/projects/)

0 commit comments

Comments
 (0)