From ec60a75cbaf37a369070ee42524bce788bd14c4b Mon Sep 17 00:00:00 2001 From: Addy Osmani Date: Fri, 23 May 2014 20:02:58 +0100 Subject: [PATCH] Add quick start information. --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index c8392d5c..8edaa9fb 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,23 @@ Web Starter Kit is a starter kit for multi-screen web development, encompassing The project aims to align with the mobile web recommendations made by Google's Web Central team and will include UX pattern samples and best practices that fall in line with some opinions we have about how multi-screen webapps should be built. +## Quickstart + +You can use Web Starter Kit just by cloning this repository and building on what we include in the `app` directory. If however you would like to use the optional tooling we provide: + +``` +# Run to install the dependencies needed (requires Node) +$ sudo npm install + +# Build the current project +$ gulp + +# Watch files / LiveReload / Cross-device sync +$ gulp watch + +# Run the deployed version of your app against PageSpeed +$ gulp pagespeed +``` ## What performance requirements does Web Starter Kit have?