Browse Source

readme

master
Lloyd Brookes 10 years ago
parent
commit
4ee20d01d8
  1. 31
      README.md

31
README.md

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

Loading…
Cancel
Save