Adds Gulp instructions in readme

KNIGHTTH0R · Feb 14, 2017 · ff7ab2a · ff7ab2a
1 parent 8be4640
commit ff7ab2a
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 33 deletions.
diff --git a/dist/README.md b/dist/README.md
@@ -1,10 +1,10 @@
-#⚠️ Looking for a maintainer ⚠️ 
+#⚠️ Looking for a maintainer ⚠️
 Please contact me if you are interested in keeping our community alive:  
 https://github.com/stevenwanderski/bxslider-4/issues/1095
 
 ---
 
-#bxSlider 4.2.5
+#bxSlider 4.2.6
 ##The fully-loaded, responsive jQuery content slider
 
 ###Why should I use this slider?
@@ -463,7 +463,7 @@ Adds Aria Live attribute to slider.
 default: true
 options: boolean (true / false)
 ```
-    
+
 **ariaHidden**
 Adds Aria Hidden attribute to any nonvisible slides.
 ```
@@ -617,25 +617,15 @@ slider = $('.bxslider').bxSlider();
 slider.destroySlider();
 ```
 
-### Install Grunt and Bower
+### Local Development with Gulp
 
 **Unfamiliar with npm? Don't have node installed?** [Download and install node.js](http://nodejs.org/download/) before proceeding.
 
 From the command line:
 
-1. Install `grunt-cli` and `bower` globally with `npm install -g grunt-cli bower`.
-2. Run `npm install`. npm will look at `package.json` and automatically install the necessary dependencies. 
-3. Run `bower install`, which installs front-end packages defined in `bower.json`.
-
-When completed, you'll be able to run the various Grunt commands provided from the command line.
-
-### Available Grunt commands
-
-* `grunt` — Clean, Compile LESS to CSS, concatenate and validate JS, build documentation.
-* `grunt dist` — Clean, Compile LESS to CSS, concatenate and validate JS for plugin only.
-* `grunt docs` — Clean, build documentation only.
-* `grunt watch` — loads LiveReload, connects, and watches all assets.
-* `grunt zip` — Creates a zip of `/dist` and places it in `/download`.
+1. Install the CLI: `npm install --global gulp-cli`
+2. Run `npm install` to install local development tools
+3. Run `gulp` which will build the project
 
 ## Contributing
 
@@ -648,13 +638,17 @@ Everyone is welcome to help [contribute](CONTRIBUTING.md) and improve this proje
 
 ## Changelog
 
+### Version 4.2.6
+* Fix: jQuery 3 support
+* Adds Gulp and removes Grunt (for easier local development)
+
 ### Version 4.2.5
 * Fix: Vertical carousel minSlides not working #840
 * Fix: slider breaks with css animations if settings.speed set to 0 #838
 * Fix: Slider runs into undefined state when reloadSlider is called before initialization was finished #833
 
 ### Version 4.2.4
-NOTICE: We have switched to a Grunt based build process in order to leverage [Assemble](http://assemble.io) for local documentation building. Please review the above notes about Grunt for the commands available. 
+NOTICE: We have switched to a Grunt based build process in order to leverage [Assemble](http://assemble.io) for local documentation building. Please review the above notes about Grunt for the commands available.
 
 * Fix: Fixed transition from first to last slide during infinite loop #778
 * Fix: Reload on multiple sliders doesn't work? #755
@@ -667,7 +661,7 @@ NOTICE: We have switched to a Grunt based build process in order to leverage [As
 * Enhancement: Slider getter through jquery object #739
 * Enhancement: Add aria attributes #751
 * Enhancement: Slider element in every callback and a new method getSliderElement (#780)
-* Enhancement: Local Documentiation and examples. I have added buildable documentation to the repo. This will expand over time and allow for community corrections as needed. Please see above Grunt notes on how to build. 
+* Enhancement: Local Documentiation and examples. I have added buildable documentation to the repo. This will expand over time and allow for community corrections as needed. Please see above Grunt notes on how to build.
 
 
 ### Version 4.2.3

diff --git a/readme.md b/readme.md
@@ -617,25 +617,15 @@ slider = $('.bxslider').bxSlider();
 slider.destroySlider();
 ```
 
-### Install Grunt and Bower
+### Local Development with Gulp
 
 **Unfamiliar with npm? Don't have node installed?** [Download and install node.js](http://nodejs.org/download/) before proceeding.
 
 From the command line:
 
-1. Install `grunt-cli` and `bower` globally with `npm install -g grunt-cli bower`.
-2. Run `npm install`. npm will look at `package.json` and automatically install the necessary dependencies.
-3. Run `bower install`, which installs front-end packages defined in `bower.json`.
-
-When completed, you'll be able to run the various Grunt commands provided from the command line.
-
-### Available Grunt commands
-
-* `grunt` — Clean, Compile LESS to CSS, concatenate and validate JS, build documentation.
-* `grunt dist` — Clean, Compile LESS to CSS, concatenate and validate JS for plugin only.
-* `grunt docs` — Clean, build documentation only.
-* `grunt watch` — loads LiveReload, connects, and watches all assets.
-* `grunt zip` — Creates a zip of `/dist` and places it in `/download`.
+1. Install the CLI: `npm install --global gulp-cli`
+2. Run `npm install` to install local development tools
+3. Run `gulp` which will build the project
 
 ## Contributing
 
@@ -648,6 +638,10 @@ Everyone is welcome to help [contribute](CONTRIBUTING.md) and improve this proje
 
 ## Changelog
 
+### Version 4.2.6
+* Fix: jQuery 3 support
+* Adds Gulp and removes Grunt (for easier local development)
+
 ### Version 4.2.5
 * Fix: Vertical carousel minSlides not working #840
 * Fix: slider breaks with css animations if settings.speed set to 0 #838