Skip to content

Commit f65cdfb

Browse files
committed
README updated with development and test documentation, also some Grunt tasks were registered.
1 parent aa71e70 commit f65cdfb

File tree

3 files changed

+61
-20
lines changed

3 files changed

+61
-20
lines changed

Gruntfile.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ module.exports = function(grunt) {
6262
});
6363

6464
grunt.registerTask('default', ['jshint', 'watch']);
65-
grunt.registerTask('build', ['jshint', 'jasmine', 'uglify']);
65+
grunt.registerTask('build', ['jshint', 'jasmine', 'uglify']);
66+
grunt.registerTask('test', ['jasmine']);
67+
grunt.registerTask('travis', ['jshint', 'jasmine']);
6668

67-
};
69+
};

README.md

Lines changed: 54 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
1-
checkboxes.js
2-
=============
1+
# checkboxes.js
32

4-
**Checkboxes.js** is a jQuery plugin that give you nice powers over your checkboxes.
3+
> A jQuery plugin that give you nice powers over your checkboxes. http://rmariuzzo.github.io/checkboxes.js
54
6-
For more information check the [documentation site](http://rmariuzzo.github.io/checkboxes.js).
5+
## Installation
76

8-
Features
9-
--------
7+
#### With bower:
8+
9+
bower install checkboxes --save-dev
10+
11+
#### Without bower:
12+
13+
1. [Download the latest release](https://github.com/rmariuzzo/checkboxes.js/releases).
14+
2. Then include `jquery.checkboxes-###.min.js` just after jQuery.
15+
16+
### Features
1017

1118
* **Check all** checkboxes in context
1219
* **Uncheck all** checkboxes in context
@@ -15,24 +22,53 @@ Features
1522
* **Limit** the number of checked checkbox per context
1623
* **Data API** like Twitter Bootstrap
1724

18-
Installation
19-
============
20-
21-
1. Include jQuery into your HTML page.
22-
2. Include [`jQuery.checkboxes.min.js`](build/jquery.checkboxes.min.js) into your HTML page, just after jQuery.
23-
24-
Documentation and examples
25-
==========================
25+
### Documentation and examples
2626

2727
* [Checking all checkboxes in a context](http://rmariuzzo.github.io/checkboxes.js/#checking-all-checkboxes)
2828
* [Unchecking all checkboxes in a context](http://rmariuzzo.github.io/checkboxes.js/#unchecking-all-checkboxes)
2929
* [Toggling all checkboxes's state in a context](http://rmariuzzo.github.io/checkboxes.js/#toggling-all-checkboxes)
3030
* [Enabling range selection of checkboxes](http://rmariuzzo.github.io/checkboxes.js/#range-selection-of-checkboxes)
3131
* [Limiting the number of checked checkboxes in a context](http://rmariuzzo.github.io/checkboxes.js/#limit-max-number-of-checked-checkboxes)
3232

33-
Credits
34-
-------
33+
## Want to contribute?
34+
35+
> All help are more than welcome!
36+
37+
#### Pre-requesites
38+
39+
- [node.js](http://nodejs.org/).
40+
- [Grunt](http://gruntjs.com/).
41+
- [Bower](http://bower.io/).
42+
43+
The process is very simple.
44+
45+
1. **[Fork](https://github.com/rmariuzzo/checkboxes.js/fork)** this respository.
46+
2. **Clone** your fork and create a branch feature branch from develop.
47+
git clone git@github.com:<your-username>/checkboxes.js.git
48+
git fetch origin
49+
git checkout develop
50+
git checkout -b feature-<super-power>
51+
3. **Install** development dependencies.
52+
npm install
53+
bower install
54+
4. **Code** and be happy!
55+
5. **Test** your code using Jasmine.
56+
6. Submit a **pull request** and grab popcorn.
57+
58+
Questions? [Hit me](https://github.com/rmariuzzo/).
59+
60+
#### ProTip:
61+
62+
- When coding run `grunt`, this will watch for any change in source and test files, then it will lint and test your code as you code.
63+
64+
## Tests
65+
66+
To run all tests:
67+
68+
grunt test
69+
70+
### Credits
3571

36-
**checkboxes.js** was created by [rmariuzzo](http://github.com/rmariuzzo) with all the love in the world.
72+
**checkboxes.js** was created by [Rubens Mariuzzo](http://github.com/rmariuzzo) with all the love in the world.
3773

38-
**checkboxes.js** would not have been possible without the help of: [jQuery](http://jquery.com/), [Highlight.js](http://softwaremaniacs.org/soft/highlight/en/), [Font Awesome](http://fortawesome.github.io/Font-Awesome/), [Glyphicons](http://glyphicons.com/), [Twitter Bootstrap](http://twitter.github.io/bootstrap/) and [Subtle Patterns](http://subtlepatterns.com/). _I'm very thankful for all!_
74+
**checkboxes.js** would not have been possible without the help of: [jQuery](http://jquery.com/), [Highlight.js](http://softwaremaniacs.org/soft/highlight/en/), [Font Awesome](http://fortawesome.github.io/Font-Awesome/), [Glyphicons](http://glyphicons.com/), [Twitter Bootstrap](http://twitter.github.io/bootstrap/) and [Subtle Patterns](http://subtlepatterns.com/). _I'm very thankful for all!_

package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,8 @@
1616
"grunt-contrib-uglify": "~0.2.2",
1717
"grunt-contrib-watch": "^0.6.1",
1818
"load-grunt-tasks": "^0.4.0"
19+
},
20+
"scripts": {
21+
"test": "grunt travis --verbose"
1922
}
2023
}

0 commit comments

Comments
 (0)