瀏覽代碼

updated readme and contributing

Emanuele Marchi 11 年之前
父節點
當前提交
d43f6d0eaa
共有 2 個文件被更改,包括 13 次插入20 次删除
  1. 10 17
      CONTRIBUTING.md
  2. 3 3
      README.md

+ 10 - 17
CONTRIBUTING.md

@@ -1,21 +1,14 @@
-If you want help us to fix bugs or add a extension please use our develop branch
+Prerequisites:
 
-At this time it was develop
+- Node and NPM
+- Gulp
 
-https://github.com/nostalgiaz/bootstrap-switch/tree/develop
+Flow:
 
-First step:
+- Checkout `develop` branch
+- Run `npm install` to get or update the dependencies
+- Run `gulp`. Gulp will run the default task and listen for further files changes
+- Work on the Coffeescript or LESS sources. Gulp will automatically update the build 
+- Once completed, submit a Pull Requests. Be sure to target `develop` as destination branch
 
-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.

+ 3 - 3
README.md

@@ -38,13 +38,13 @@ $("[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.
+If you want to use your custom Bootstrap variables, choose the appropriate `bootstrap-switch.less` source file among versions 2 and 3 and include it in your LESS stack.
 
 Supported browsers
 ------------------
-IE8+ and all the other modern browsers (until proven otherwise: submit a issue and let's see what we can do).
+IE9+ and all the other modern browsers (until proven otherwise: submit a issue and let's see what we can do).
 
 License
 -------