From 69766cdf3f4e10043d009f38da1f6e6f599d29ff Mon Sep 17 00:00:00 2001 From: Lloyd Brookes Date: Tue, 4 Jun 2013 14:23:50 +0100 Subject: [PATCH] readme --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8e5d8c3..2d57f31 100644 --- a/README.md +++ b/README.md @@ -1 +1,19 @@ -Fires up a local development server \ No newline at end of file +Fires up a local development server on a given port. + +Install +======= +Install [Node.js](http://nodejs.org), then run + +```sh +$ npm install -g local-web-server +``` + +*Linux/Mac users may require to run the above with `sudo`* + +Usage +===== +From the root folder of your website, run: +```sh +$ ws [port] +``` +The default port is 8000. \ No newline at end of file