Browse Source

updated README

Emanuele Marchi 10 years ago
parent
commit
b9dcb20bbb
1 changed files with 21 additions and 5 deletions
  1. 21 5
      README.md

+ 21 - 5
README.md

@@ -1,14 +1,27 @@
 # Bootstrap Switch
-[![Dependency Status](https://david-dm.org/nostalgiaz/bootstrap-switch.svg?theme=shields.io)](https://david-dm.org/nostalgiaz/bootstrap-switch)
-[![devDependency Status](https://david-dm.org/nostalgiaz/bootstrap-switch/dev-status.svg?theme=shields.io)](https://david-dm.org/nostalgiaz/bootstrap-switch#info=devDependencies)
-[![NPM Version](http://img.shields.io/npm/v/bootstrap-switch.svg)](https://www.npmjs.org/)
+[![Dependency Status](https://david-dm.org/nostalgiaz/bootstrap-switch.svg?style=flat)](https://david-dm.org/nostalgiaz/bootstrap-switch)
+[![devDependency Status](https://david-dm.org/nostalgiaz/bootstrap-switch/dev-status.svg?style=flat)](https://david-dm.org/nostalgiaz/bootstrap-switch#info=devDependencies)
+[![NPM Version](http://img.shields.io/npm/v/bootstrap-switch.svg?style=flat)](https://www.npmjs.org/)
+[![](http://img.shields.io/github/issues/badges/shields.svg?style=flat)](https://github.com/nostalgiaz/bootstrap-switch/issues)
 
 Turn checkboxes and radio buttons in toggle switches.
 
+## Contribute
+
+Hi, Emanuele here. I am currently the sole contributor of Bootstrap Switch and have been mantaining it for quite a considerable amount of time.
+The development pace is strongly affected by the personal lack of time and a missing core team behind the project.
+It would be nice to have someone available for clearing the list of open issues and occasionally implementing new functionalities.
+If interest, you can drop me a line or pick a bug, kill it and open a Pull Request against `develop` branch.
+Many thanks.
+
 ## Demo and Documentation
-http://www.bootstrap-switch.org
 
-## Usage
+- [Examples](http://www.bootstrap-switch.org/examples.html)
+- [Options](http://www.bootstrap-switch.org/options-3.html)
+- [Methods](http://www.bootstrap-switch.org/methods-3.html)
+- [Events](http://www.bootstrap-switch.org/events-3.html)
+
+## Getting started
 
 Include the dependencies: jQuery, Bootstrap and Bootstrap Switch CSS + Javascript:
 
@@ -40,14 +53,17 @@ Enjoy.
 If you want to use your bootstrap variables, include `bootstrap-switch.less` in your compilation stack. You can even choose among Bootstrap versions 2.3.2 or 3.*.* compatible source.
 
 ## AngularJs
+
 Two custom directives are available:
 - [angular-bootstrap-switch](https://github.com/frapontillo/angular-bootstrap-switch)
 - [angular-toggle-switch](https://github.com/JumpLink/angular-toggle-switch)
 
 ## KnockoutJs
+
 A Knockout binding handler is available [here](https://github.com/pauloortins/knockout-bootstrap-switch)
 
 ## NuGet
+
 A NuGet package is available [here](https://github.com/blachniet/bootstrap-switch-nuget)
 
 ## Supported browsers