diff --git a/README.md b/README.md index b729c22e6..8c192d169 100755 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ All contributions are welcome! ## Requirements -This project requires [NodeJS](http://nodejs.org) to be installed on your machine. Works with 0.10, 0.12, and 4.1! **Note that parts of our build process will break with NPM 3, due to the changes in how packages are installed.** +This project requires [NodeJS](http://nodejs.org) to be installed on your machine. FoundationPress uses [Sass](http://Sass-lang.com/) (CSS with superpowers). In short, Sass is a CSS pre-processor that allows you to write styles more effectively and tidy. @@ -26,7 +26,7 @@ $ cd FoundationPress $ npm install ``` -(Many project force their users to install [Bower](http://bower.io) and [Grunt](http://gruntjs.com/) globally. We don't like that and decided to use them via `npm scripts` which means, that Grunt and Bower are installed in your `node_modules` folder and we'll call them there. Bower install and grunt build will be called via npm scripts when you run npm install.) +(Many projects force their users to install [Bower](http://bower.io) and [Grunt](http://gruntjs.com/) globally. We don't like that and decided to use them via `npm scripts` which means, that Grunt and Bower are installed in your `node_modules` folder and we'll call them there. Bower install and grunt build will be called via npm scripts when you run npm install.) ### 2. While you're working on your project, run: @@ -35,6 +35,11 @@ $ npm install $ npm run watch ``` +If you want to take advantage of browser-sync (automatic browser refresh when a file is saved), simply enter the URL of your local WP-server in Gruntfile.js line 184, save and run +```bash +$ npm run browsersync +``` + ### 3. For building all the assets, run: ```bash diff --git a/package.json b/package.json index fcf9b9e8b..8f767ca69 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "foundationpress", "title": "FoundationPress", - "version": "1.5.1", + "version": "1.6.0", "description": "FoundationPress is a WordPress starter theme based on Foundation 5 by Zurb", "keywords": [ "FoundationPress", @@ -41,6 +41,7 @@ "grunt": "grunt", "postinstall": "bower install && grunt build", "watch": "grunt watch", + "browsersync": "grunt browser-sync", "package": "grunt package" } } diff --git a/style.css b/style.css index 0d222618c..74bd877e8 100755 --- a/style.css +++ b/style.css @@ -3,7 +3,7 @@ Theme Name: FoundationPress Theme URI: http://foundationpress.olefredrik.com Github Theme URI: https://github.com/olefredrik/FoundationPress Description: FoundationPress is a WordPress starter theme based on Foundation 5 by Zurb -Version: 1.5.1 +Version: 1.6.0 Author: Ole Fredrik Lie Author URI: http://olefredrik.com/