From 16a873b42ba0b678ed0b850aeca40595338ce02e Mon Sep 17 00:00:00 2001 From: Riku Rouvila Date: Mon, 3 Feb 2014 21:05:38 +0200 Subject: [PATCH] Update README.md --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 73eda5d..c45c859 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,13 @@ # Project template for [gulp.js](http://gulpjs.com/) +## What it does +* [Jade](jade-lang.com) files to HTML +* [Stylus](http://learnboost.github.io/stylus) files to CSS +* [CoffeeScript](http://coffeescript.org/) files to Javascript through [browserify](http://browserify.org/) + * You are able to use 'require' in your client-side code +* Serves your static files to localhost:9001 +* Reloads your browser with LiveReload when files change + ## Getting things up and running git clone git@github.com:leonidas/gulp-project-template.git @@ -7,5 +15,13 @@ npm start open http://localhost:9001 in your browser +## Commands +* npm install + * Installs server-side dependencies from NPM and client-side dependencies from Bower +* npm start + * Compiles your files, starts watching files for changes, serves static files to port 9001 +* npm run build + * Builds & minifies everything + ## Enable LiveReload Install [LiveReload for Chrome](https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei?hl=en)