From aede8a60ad3434509068ab81e1f06b8a05b45562 Mon Sep 17 00:00:00 2001 From: Lloyd Brookes Date: Tue, 17 Jun 2014 00:48:24 +0100 Subject: [PATCH] readme --- README.md | 17 +++++++++++++++-- lib/cli-options.js | 2 +- 2 files changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cf5cdf0..e120bfa 100644 --- a/README.md +++ b/README.md @@ -22,9 +22,22 @@ $ npm install -g local-web-server Usage ----- ``` -$ ws [--directory|-d ] [--port|-p ] [--log-format|-f dev|default|short|tiny|logstalgia] [--compress|-c] +Usage +$ ws $ ws --config -$ ws --help|-h +$ ws --help + +Server +-p, --port Web server port +-f, --log-format Access log format, written to stdout. Use one of + 'none', 'dev', 'default', 'short', 'tiny' or 'logstalgia' +-d, --directory Root directory, defaults to the current directory +-c, --compress Enables compression +-r, --refreshRate Statistics view refresh rate in ms. Defaults to 500. + +Misc +-h, --help Print these usage instructions +--config Prints the stored config ``` From the folder you wish to serve, run: diff --git a/lib/cli-options.js b/lib/cli-options.js index bb64505..6967377 100644 --- a/lib/cli-options.js +++ b/lib/cli-options.js @@ -33,7 +33,7 @@ module.exports = [ }, { name: "config", type: Boolean, - description: "Prints the stored config" + description: "Print the stored config" } ] }