Browse Source

readme

master
Lloyd Brookes 10 years ago
parent
commit
5e51768be8
  1. 14
      README.md

14
README.md

@ -47,6 +47,9 @@ $ npm start
## Usage ## Usage
``` ```
local-web-server
Lightweight static web server, zero configuration.
Usage Usage
$ ws <server options> $ ws <server options>
$ ws --config $ ws --config
@ -54,17 +57,18 @@ $ ws --help
Server Server
-p, --port <number> Web server port -p, --port <number> Web server port
-f, --log-format <string> 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').
-f, --log-format <string> 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 <string> Root directory, defaults to the current directory -d, --directory <string> Root directory, defaults to the current directory
-c, --compress Enables compression
-c, --compress Enable gzip compression, reduces bandwidth.
-r, --refresh-rate <number> Statistics view refresh rate in ms. Defaults to 500. -r, --refresh-rate <number> Statistics view refresh rate in ms. Defaults to 500.
Misc Misc
-h, --help Print these usage instructions -h, --help Print these usage instructions
--config Print the stored config --config Print the stored config
Project home: https://github.com/75lb/local-web-server
``` ```
From the folder you wish to serve, run: From the folder you wish to serve, run:

Loading…
Cancel
Save