From 812b169e26c4f506c1be83b8c04296f78a1eeddc Mon Sep 17 00:00:00 2001 From: Ben Word Date: Sat, 21 Feb 2015 14:30:00 -0600 Subject: [PATCH] Update README --- README.md | 25 +++++++++---------------- 1 file changed, 9 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 02a5b55..b420938 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Build Status](https://travis-ci.org/roots/roots.svg)](https://travis-ci.org/roots/roots) [![devDependency Status](https://david-dm.org/roots/roots/dev-status.svg)](https://david-dm.org/roots/roots#info=devDependencies) -Sage is a WordPress starter theme based on [HTML5 Boilerplate](http://html5boilerplate.com/) that will help you make better themes. +Sage is a WordPress starter theme based on HTML5 Boilerplate, gulp, Bower, and Bootstrap, that will help you make better themes. * Source: [https://github.com/roots/sage](https://github.com/roots/sage) * Homepage: [https://roots.io/sage/](https://roots.io/sage/) @@ -15,41 +15,32 @@ Sage is a WordPress starter theme based on [HTML5 Boilerplate](http://html5boile * PHP >= 5.4 * Node.js >= 0.10 -* npm >= 2.1.5 +* npm >= 2.1.5 (`npm install -g npm@latest`) * gulp (`npm install -g gulp`) * Bower (`npm install -g bower`) ## Features -* [gulp](http://gulpjs.com/) for compiling Sass and LESS, checking for JavaScript errors, live reloading, concatenating and minifying files, and versioning assets +* [gulp](http://gulpjs.com/) build script that compiles both Less and Sass, checks for JavaScript errors, optimizes images, and concatenates and minifies files +* [BrowserSync](http://www.browsersync.io/) for keeping multiple browsers and devices synchronized while testing, along with injecting updated CSS and JS into your browser while you're developing * [Bower](http://bower.io/) for front-end package management +* [Bootstrap](http://getbootstrap.com/) +* [Theme wrapper](https://roots.io/sage/docs/theme-wrapper/) * [HTML5 Boilerplate](http://html5boilerplate.com/) * The latest [jQuery](http://jquery.com/) via Google CDN, with a local fallback * The latest [Modernizr](http://modernizr.com/) build for feature detection * An optimized Google Analytics snippet -* [Bootstrap](http://getbootstrap.com/) * ARIA roles and microformats -* [Theme wrapper](https://roots.io/sage/docs/theme-wrapper/) * Cleaner HTML output of navigation menus * Posts use the [hNews](http://microformats.org/wiki/hnews) microformat * [Multilingual ready](https://roots.io/wpml/) and over 30 available [community translations](https://github.com/roots/sage-translations) -### Go further with Sage - -#### Clean up WordPress Install the [Soil](https://github.com/roots/soil) plugin to enable additional features: * Cleaner output of `wp_head` and enqueued assets * Root relative URLs * Nice search (`/search/query/`) -#### Modernize your WordPress stack -[Bedrock](https://github.com/roots/bedrock) gets you started with the best development tools, practices, and project structure: - -* Dependency management with Composer -* Automated deployments with Capistrano -* Easy environment specific configuration - ## Installation Clone the git repo - `git clone https://github.com/roots/sage.git` and then rename the directory to the name of your theme or website. @@ -87,7 +78,8 @@ You now have all the necessary dependencies to run the build process. * `gulp` — Compile and optimize the files in your assets directory * `gulp watch` — Compile assets when file changes are made * `gulp --production` — Compile assets for production (no source maps). -* `gulp --tasks` — Lists all the available tasks and what they do + +To use BrowserSync during `gulp watch` you need update `devUrl` at the bottom of `assets/manifest.json` to reflect your local development hostname. ## Documentation @@ -104,3 +96,4 @@ Keep track of development and community news. * Participate on the [Roots Discourse](https://discourse.roots.io/) * Follow [@rootswp on Twitter](https://twitter.com/rootswp) * Read and subscribe to the [Roots Blog](https://roots.io/blog/) +* Subscribe to the [Roots Newsletter](https://roots.io/subscribe/)