Browse Source

updated readme and contributing

Emanuele Marchi 11 years ago
parent
commit
048f615fba
2 changed files with 16 additions and 31 deletions
  1. 5 19
      CONTRIBUTING.md
  2. 11 12
      README.md

+ 5 - 19
CONTRIBUTING.md

@@ -1,21 +1,7 @@
-If you want help us to fix bugs or add a extension please use our develop branch
+If you want help to fix bugs or propose a feature:
 
-At this time it was develop
+- Checkout `develop` branch
+- Always work on this branch for fixes
+- Once done, submit us your Pull Requests. Always pick `develop` as destination branch
 
-https://github.com/nostalgiaz/bootstrap-switch/tree/develop
-
-First step:
-
-Please merge your branch develop with nostalgiaz/bootstrap-switch/tree/develop
-
-second step:
-
-Work in the branch develop for fixes
-
-third step:
-
-regularly reviews the branch develop for updates and then merge this with your branch develop
-
-fourth step:
-
-When you're done in your branch send us a PR to merge the two branches
+Thank you.

+ 11 - 12
README.md

@@ -1,17 +1,16 @@
-Bootstrap Switch
-================
+# Bootstrap Switch 
+[![Dependency Status](https://david-dm.org/nostalgiaz/bootstrap-switch.png)](https://david-dm.org/nostalgiaz/bootstrap-switch)
+[![devDependency Status](https://david-dm.org/nostalgiaz/bootstrap-switch/dev-status.png)](https://david-dm.org/nostalgiaz/bootstrap-switch#info=devDependencies)
 
 Turn checkboxes and radio buttons in toggle switches.
 
 **Version 3 is almost ready and features a entire API redesign and source rewriting. Knowing that, your help would be decisive to ship it within days. Give the branch `3.0` a try and post any bugs you might encounter or improvements you would like to integrate in the final release.
 With heart, many thanks.**
 
-Demo and Documentation
-----------------------
+## Demo and Documentation
 http://www.bootstrap-switch.org
 
-Usage
------
+## Usage
 
 Include the dependencies: jQuery, Bootstrap and Bootstrap Switch CSS + Javascript:
 
@@ -38,15 +37,15 @@ $("[name='my-checkbox']").bootstrapSwitch();
 
 Enjoy.
 
-Less
-----
+## Less
+
 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.
 
-Supported browsers
-------------------
+## Supported browsers
+
 IE8+ and all the other modern browsers (until proven otherwise: submit a issue and let's see what we can do).
 
-License
--------
+## License
+
 Licensed under the Apache License, Version 2.0
 http://www.apache.org/licenses/LICENSE-2.0