@@ -63,6 +63,88 @@ Display the number of forks in a repository.
6363
6464Display the number of issues in a repository.
6565
66+ ## Structure
67+
68+ The basic structure of the project is given in the following way:
69+
70+ ```
71+ .
72+ |-- assets/
73+ |-- demo/
74+ | |-- index.html
75+ |-- dist/
76+ | |-- jquery.boilerplate.js
77+ | |-- jquery.boilerplate.min.js
78+ |-- src/
79+ | |-- jquery.boilerplate.coffee
80+ | |-- jquery.boilerplate.js
81+ |-- .editorconfig
82+ |-- .gitignore
83+ |-- .jshintrc
84+ |-- .travis.yml
85+ |-- github.jquery.json
86+ |-- Gruntfile.js
87+ `-- package.json
88+ ```
89+
90+ #### [ assets/] ( https://github.com/zenorocha/jquery-github/tree/master/assets )
91+
92+ Contains CSS and Font files to create that lovely Github box.
93+
94+ #### [ demo/] ( https://github.com/zenorocha/jquery-github/tree/master/demo )
95+
96+ Contains a simple HTML file to demonstrate the plugin.
97+
98+ #### [ dist/] ( https://github.com/zenorocha/jquery-github/tree/master/dist )
99+
100+ This is where the generated files are stored once Grunt runs JSHint and other stuff.
101+
102+ #### [ src/] ( https://github.com/zenorocha/jquery-github/tree/master/src )
103+
104+ Contains the files responsible for the plugin.
105+
106+ #### [ .editorconfig] ( https://github.com/zenorocha/jquery-github/tree/master/.editorconfig )
107+
108+ This file is for unifying the coding style for different editors and IDEs.
109+
110+ > Check [ editorconfig.org] ( http://editorconfig.org ) if you haven't heard about this project yet.
111+
112+ #### [ .gitignore] ( https://github.com/zenorocha/jquery-github/tree/master/.gitignore )
113+
114+ List of files that we don't want Git to track.
115+
116+ > Check this [ Git Ignoring Files Guide] ( https://help.github.com/articles/ignoring-files ) for more details.
117+
118+ #### [ .jshintrc] ( https://github.com/zenorocha/jquery-github/tree/master/.jshintrc )
119+
120+ List of rules used by JSHint to detect errors and potential problems in JavaScript.
121+
122+ > Check [ jshint.com] ( http://jshint.com/about/ ) if you haven't heard about this project yet.
123+
124+ #### [ .travis.yml] ( https://github.com/zenorocha/jquery-github/tree/master/.travis.yml )
125+
126+ Definitions for continous integration using Travis.
127+
128+ > Check [ travis-ci.org] ( http://about.travis-ci.org/ ) if you haven't heard about this project yet.
129+
130+ #### [ github.jquery.json] ( https://github.com/zenorocha/jquery-github/tree/master/github.jquery.json )
131+
132+ Package manifest file used to publish plugins in jQuery Plugin Registry.
133+
134+ > Check this [ Package Manifest Guide] ( http://plugins.jquery.com/docs/package-manifest/ ) for more details.
135+
136+ #### [ Gruntfile.js] ( https://github.com/zenorocha/jquery-github/tree/master/Gruntfile.js )
137+
138+ Contains all automated tasks using Grunt.
139+
140+ > Check [ gruntjs.com] ( http://gruntjs.com ) if you haven't heard about this project yet.
141+
142+ #### [ package.json] ( https://github.com/zenorocha/jquery-github/tree/master/package.json )
143+
144+ Specify all dependencies loaded via Node.JS.
145+
146+ > Check [ NPM] ( https://npmjs.org/doc/json.html ) for more details.
147+
66148## Showcase
67149
68150* [ zenorocha.com/projects] ( http://zenorocha.com/projects/ )
@@ -80,11 +162,11 @@ No problem, [@ricardobeat](https://github.com/ricardobeat) already did one. Chec
80162
81163## Contributing
82164
83- Check [ CONTRIBUTING.md] ( https://github.com/zenorocha/jquery-github/blob/master/CONTRIBUTING.md ) .
165+ Check [ CONTRIBUTING.md] ( https://github.com/zenorocha/jquery-github/blob/master/CONTRIBUTING.md )
84166
85167## History
86168
87- Check [ HISTORY.md] ( https://github.com/zenorocha/jquery-github/blob/master/HISTORY.md ) .
169+ Check [ HISTORY.md] ( https://github.com/zenorocha/jquery-github/blob/master/HISTORY.md )
88170
89171## Credits
90172
0 commit comments