Skip to content

Commit f8cadb7

Browse files
committed
adding versioning history, license and usage
1 parent e0fa2ab commit f8cadb7

File tree

1 file changed

+38
-13
lines changed

1 file changed

+38
-13
lines changed

README.md

Lines changed: 38 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,56 @@
1-
# Project Name
1+
# jQuery Github Repos
22

3-
TODO: Write a project description
3+
A jQuery plugin to display your Github Repositories.
44

5-
## Installation
5+
## Usage
66

7-
TODO: Describe the installation process
7+
Use the `github-widget` class and create an attribute called `data-repo`:
88

9-
## Usage
9+
```html
10+
<div class="github-widget" data-repo="jquery-boilerplate/boilerplate"></div>
11+
```
12+
13+
Include jQuery:
14+
15+
```html
16+
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js"></script>
17+
```
18+
19+
Include this jQuery plugin:
1020

11-
TODO: Write usage instructions
21+
```html
22+
<script src="jquery.github.repos.min.js"></script>
23+
```
24+
25+
Call the plugin:
26+
27+
```html
28+
<script>
29+
$('.github-repos').githubRepos();
30+
</script>
31+
```
32+
33+
And that's it \o/
1234

1335
## Contributing
1436

1537
1. Fork it!
1638
2. Create your feature branch: `git checkout -b my-new-feature`
17-
3. Commit your changesL `git commit -am 'Add some feature'`
39+
3. Commit your changes: `git commit -am 'Add some feature'`
1840
4. Push to the branch: `git push origin my-new-feature`
1941
5. Submit a pull request :D
2042

2143
## History
2244

23-
TODO: Write history
24-
25-
## Credits
26-
27-
TODO: Write credits
45+
* v0.3 January 13, 2013
46+
* Replaced single images for a sprite
47+
* Added minified version
48+
* v0.2 September 11, 2012
49+
* Code wrapped into a jQuery plugin
50+
* Demonstration page created
51+
* v0.1 September 10, 2012
52+
* Initial commit
2853

2954
## License
3055

31-
TODO: Write license
56+
[MIT License](http://zenorocha.mit-license.org/)

0 commit comments

Comments
 (0)