From 4ee20d01d8b1c5a6bafdc77a69744af62f9c31b1 Mon Sep 17 00:00:00 2001 From: Lloyd Brookes Date: Fri, 10 Jul 2015 23:37:47 +0100 Subject: [PATCH] readme --- README.md | 39 +++++++++++++++++---------------------- 1 file changed, 17 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index c8297ae..7efe693 100644 --- a/README.md +++ b/README.md @@ -47,28 +47,23 @@ $ npm start ## Usage ``` - local-web-server - Lightweight static web server, zero configuration. - - Usage - $ ws - $ ws --config - $ ws --help - - Server - -p, --port Web server port - -f, --log-format If a format is supplied an access log is written to stdout. If not, a statistics view is displayed. Use a - preset ('none', 'dev','combined', 'short', 'tiny' or 'logstalgia') or supply a custom format (e.g. ':method -> - :url'). - -d, --directory Root directory, defaults to the current directory - -c, --compress Enable gzip compression, reduces bandwidth. - -r, --refresh-rate Statistics view refresh rate in ms. Defaults to 500. - - Misc - -h, --help Print these usage instructions - --config Print the stored config - - Project home: https://github.com/75lb/local-web-server +Usage +$ ws +$ ws --config +$ ws --help + +Server +-p, --port Web server port +-f, --log-format If a format is supplied an access log is written to stdout. If not, a statistics view is displayed. Use a + preset ('none', 'dev','combined', 'short', 'tiny' or 'logstalgia') or supply a custom format (e.g. ':method -> + :url'). +-d, --directory Root directory, defaults to the current directory +-c, --compress Enable gzip compression, reduces bandwidth. +-r, --refresh-rate Statistics view refresh rate in ms. Defaults to 500. + +Misc +-h, --help Print these usage instructions +--config Print the stored config ``` From the folder you wish to serve, run: