Browse Source

added Bugs and feature requests to the README.md file

Mattia Larentis 10 years ago
parent
commit
f1c53cbca9
1 changed files with 34 additions and 7 deletions
  1. 34 7
      README.md

+ 34 - 7
README.md

@@ -4,6 +4,15 @@
 [![NPM Version](http://img.shields.io/npm/v/bootstrap-switch.svg?style=flat)](https://www.npmjs.org/)
 
 Turn checkboxes and radio buttons into toggle switches.
+This library is created by [Mattia Larentis](http://github.com/nostalgiaz) and maintained by the core team, with the help of the community.
+
+To get started, check out [http://bootstrap-switch.org](http://bootstrap-switch.org)!
+
+#### Core team
+- [Mattia Larentis](http://github.com/nostalgiaz)
+- [Emanuele Marchi](http://github.com/lostcrew)
+- **you?** drop me a line.
+
 
 ## Demo and Documentation
 
@@ -12,6 +21,7 @@ Turn checkboxes and radio buttons into toggle switches.
 - [Methods](http://www.bootstrap-switch.org/methods.html)
 - [Events](http://www.bootstrap-switch.org/events.html)
 
+
 ## Getting started
 
 Include the dependencies: jQuery, Bootstrap and Bootstrap Switch CSS + Javascript:
@@ -39,10 +49,31 @@ $("[name='my-checkbox']").bootstrapSwitch();
 
 Enjoy.
 
+
+## Supported browsers
+
+IE9+ and all the other modern browsers.
+
+
 ## LESS + SASS
 
 Import `src/less/bootstrap2/bootstrap-switch.less` for version <= 2.3.2 or `src/less/bootstrap3/bootstrap-switch.less` for version <= 3.3.4 in your compilation stack.
 
+
+## Bugs and feature requests
+
+Have a bug or a feature request? Please first search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/nostalgiaz/bootstrap-switch/issues/new). 
+
+The new issue should contain both a summary of the issue and the browser/OS environment in which it occurs and a link to the playground you prefer with the reduced test case.
+If suitable, include the steps required to reproduce the bug.
+
+Please do not use the issue tracker for personal support requests: [Stack Overflow](http://stackoverflow.com/questions/tagged/bootstrap-switch) is a better place to get help.
+
+#### Known issues
+
+- Make sure `.form-control` is not applied to the input. Bootstrap does not support that, refer to [Checkboxes and radios](http://getbootstrap.com/css/#checkboxes-and-radios)
+
+
 ## Integrations
 
 ### AngularJs
@@ -59,15 +90,11 @@ A Knockout binding handler is available [here](https://github.com/pauloortins/kn
 
 A NuGet package is available [here](https://github.com/blachniet/bootstrap-switch-nuget)
 
-## Supported browsers
-
-IE9+ and all the other modern browsers.
-
-## Known issues
-
-- Make sure `.form-control` is not applied to the input. Bootstrap does not support that, refer to [Checkboxes and radios](http://getbootstrap.com/css/#checkboxes-and-radios)
 
 ## License
 
 Licensed under the Apache License, Version 2.0
 http://www.apache.org/licenses/LICENSE-2.0
+
+We are in the process of changing from Apache to MIT. If you contributed before February 5th, 2015, please add your vote here to accept license change: 
+[https://github.com/nostalgiaz/bootstrap-switch/issues/347](https://github.com/nostalgiaz/bootstrap-switch/issues/347)