2
2
3
3
[ ![ Github Repo Demonstration] ( http://f.cl.ly/items/2I3u29002A1g2w1R1I0X/Screen%20Shot%202013-01-17%20at%202.16.36%20PM.png )] ( http://zenorocha.github.com/jquery-github/ )
4
4
5
+ > A jQuery plugin to display your Github Repositories.
6
+
7
+ ## Browser Support
8
+
9
+ We do care about it.
10
+
11
+ ![ IE] ( https://raw.github.com/paulirish/browser-logos/master/ie/ie_48x48.png ) | ![ Chrome] ( https://raw.github.com/paulirish/browser-logos/master/chrome/chrome_48x48.png ) | ![ Firefox] ( https://raw.github.com/paulirish/browser-logos/master/firefox/firefox_48x48.png ) | ![ Opera] ( https://raw.github.com/paulirish/browser-logos/master/opera/opera_48x48.png ) | ![ Safari] ( https://raw.github.com/paulirish/browser-logos/master/safari/safari_48x48.png )
12
+ --- | --- | --- | --- | --- |
13
+ IE 8+ ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ |
14
+
5
15
## Getting started
6
16
7
17
Three quick start options are available:
@@ -12,12 +22,14 @@ Three quick start options are available:
12
22
13
23
## Setup
14
24
15
- Use [ Bower] ( http://bower.io ) to fetch all dependencies and you're ready to go :
25
+ Use [ Bower] ( http://bower.io ) to fetch all dependencies:
16
26
17
27
``` sh
18
28
$ bower install
19
29
```
20
30
31
+ Now you're ready to go!
32
+
21
33
## Usage
22
34
23
35
Create an attribute called ` data-repo ` :
@@ -92,7 +104,6 @@ The basic structure of the project is given in the following way:
92
104
|-- dist/
93
105
| |-- jquery.boilerplate.js
94
106
| |-- jquery.boilerplate.min.js
95
- |-- lib/
96
107
|-- src/
97
108
| |-- jquery.boilerplate.coffee
98
109
| |-- jquery.boilerplate.js
@@ -109,6 +120,10 @@ The basic structure of the project is given in the following way:
109
120
110
121
Contains CSS and Font files to create that lovely Github box.
111
122
123
+ #### bower_components/
124
+
125
+ Contains all dependencies like jQuery and Zepto.
126
+
112
127
#### [ demo/] ( https://github.com/zenorocha/jquery-github/tree/master/demo )
113
128
114
129
Contains a simple HTML file to demonstrate the plugin.
@@ -117,10 +132,6 @@ Contains a simple HTML file to demonstrate the plugin.
117
132
118
133
This is where the generated files are stored once Grunt runs JSHint and other stuff.
119
134
120
- #### [ lib/] ( https://github.com/zenorocha/jquery-github/tree/master/lib )
121
-
122
- Contains libraries like jQuery and Zepto.
123
-
124
135
#### [ src/] ( https://github.com/zenorocha/jquery-github/tree/master/src )
125
136
126
137
Contains the files responsible for the plugin.
@@ -186,14 +197,6 @@ No problem, [@ricardobeat](https://github.com/ricardobeat) already did one. Chec
186
197
187
198
No problem, [ @igorlima ] ( https://github.com/igorlima ) already did that. Check [ demo/index-zepto.html] ( https://github.com/zenorocha/jquery-github/tree/master/demo/index-zepto.html ) .
188
199
189
- ## Browser Support
190
-
191
- We do care about it.
192
-
193
- ![ IE] ( https://raw.github.com/paulirish/browser-logos/master/ie/ie_48x48.png ) | ![ Chrome] ( https://raw.github.com/paulirish/browser-logos/master/chrome/chrome_48x48.png ) | ![ Firefox] ( https://raw.github.com/paulirish/browser-logos/master/firefox/firefox_48x48.png ) | ![ Opera] ( https://raw.github.com/paulirish/browser-logos/master/opera/opera_48x48.png ) | ![ Safari] ( https://raw.github.com/paulirish/browser-logos/master/safari/safari_48x48.png )
194
- --- | --- | --- | --- | --- |
195
- IE 8+ ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ |
196
-
197
200
## Contributing
198
201
199
202
Check [ CONTRIBUTING.md] ( https://github.com/zenorocha/jquery-github/blob/master/CONTRIBUTING.md ) .
0 commit comments