File tree 1 file changed +38
-13
lines changed
1 file changed +38
-13
lines changed Original file line number Diff line number Diff line change 1
- # Project Name
1
+ # jQuery Github Repos
2
2
3
- TODO: Write a project description
3
+ A jQuery plugin to display your Github Repositories.
4
4
5
- ## Installation
5
+ ## Usage
6
6
7
- TODO: Describe the installation process
7
+ Use the ` github-widget ` class and create an attribute called ` data-repo ` :
8
8
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:
10
20
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/
12
34
13
35
## Contributing
14
36
15
37
1 . Fork it!
16
38
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' `
18
40
4 . Push to the branch: ` git push origin my-new-feature `
19
41
5 . Submit a pull request : D
20
42
21
43
## History
22
44
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
28
53
29
54
## License
30
55
31
- TODO: Write license
56
+ [ MIT License ] ( http://zenorocha.mit- license.org/ )
You can’t perform that action at this time.
0 commit comments