Browse Source

readme

master
Lloyd Brookes 11 years ago
parent
commit
aede8a60ad
  1. 17
      README.md
  2. 2
      lib/cli-options.js

17
README.md

@ -22,9 +22,22 @@ $ npm install -g local-web-server
Usage Usage
----- -----
``` ```
$ ws [--directory|-d <directory>] [--port|-p <port>] [--log-format|-f dev|default|short|tiny|logstalgia] [--compress|-c]
Usage
$ ws <server options>
$ ws --config $ ws --config
$ ws --help|-h
$ ws --help
Server
-p, --port <number> Web server port
-f, --log-format <string> Access log format, written to stdout. Use one of
'none', 'dev', 'default', 'short', 'tiny' or 'logstalgia'
-d, --directory <string> Root directory, defaults to the current directory
-c, --compress Enables compression
-r, --refreshRate <number> 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: From the folder you wish to serve, run:

2
lib/cli-options.js

@ -33,7 +33,7 @@ module.exports = [
}, },
{ {
name: "config", type: Boolean, name: "config", type: Boolean,
description: "Prints the stored config"
description: "Print the stored config"
} }
] ]
} }

Loading…
Cancel
Save