Skip to content

Commit 5878da0

Browse files
committed
Readme file updated with docs site and brand renaming.
1 parent 4624293 commit 5878da0

File tree

1 file changed

+24
-10
lines changed

1 file changed

+24
-10
lines changed

README.md

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,38 @@
1-
checkbox.js
2-
===========
1+
checkboxes.js
2+
=============
33

4-
**Checkbox.js** is a jQuery plugin that give you some nice powers to your checkboxes.
4+
**Checkboxes.js** is a jQuery plugin that give you nice powers over your checkboxes.
5+
6+
For more information check the [documentation site](http://rmariuzzo.github.io/checkboxes.js).
57

68
Features
79
--------
810

9-
* Check all checkboxes in context.
10-
* Uncheck all checkboxes in context.
11-
* Allow range selection of checkboxes in context.
12-
* Limit quantity of checkbox able to be checked in context.
11+
* **Check all** checkboxes in context
12+
* **Uncheck all** checkboxes in context
13+
* **Toggle states** of all checkboxes in context
14+
* Enable **range selection**
15+
* **Limit** the number of checked checkbox per context
16+
* **Data API** like Twitter Bootstrap
1317

1418
Installation
1519
------------
1620

1721
1. Include jQuery into your HTML page.
1822
2. Include [`jQuery.checkboxes.min.js`](build/jquery.checkboxes.min.js) into your HTML page, just after jQuery.
1923

20-
Documentation and example
21-
-------------------------
24+
Documentation and examples
25+
--------------------------
26+
27+
* [Checking all checkboxes in a context](http://rmariuzzo.github.io/checkboxes.js/#checking-all-checkboxes)
28+
* [Unchecking all checkboxes in a context](http://rmariuzzo.github.io/checkboxes.js/#unchecking-all-checkboxes)
29+
* [Toggling all checkboxes's state in a context](http://rmariuzzo.github.io/checkboxes.js/#toggling-all-checkboxes)
30+
* [Enabling range selection of checkboxes](http://rmariuzzo.github.io/checkboxes.js/#range-selection-of-checkboxes)
31+
* [Limiting the number of checked checkboxes in a context](http://rmariuzzo.github.io/checkboxes.js/#limit-max-number-of-checked-checkboxes)
32+
33+
Credits
34+
-------
2235

23-
Visit the [documentation site](http://rmariuzzo.github.io/checkboxes.js).
36+
**checkboxes.js** was created by [rmariuzzo](http://github.com/rmariuzzo) with all the love in the world.
2437

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!_

0 commit comments

Comments
 (0)