readme
This commit is contained in:
35
README.md
35
README.md
@ -47,28 +47,23 @@ $ npm start
|
|||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
```
|
```
|
||||||
local-web-server
|
Usage
|
||||||
Lightweight static web server, zero configuration.
|
$ ws <server options>
|
||||||
|
$ ws --config
|
||||||
|
$ ws --help
|
||||||
|
|
||||||
Usage
|
Server
|
||||||
$ ws <server options>
|
-p, --port <number> Web server port
|
||||||
$ ws --config
|
-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
|
||||||
$ ws --help
|
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.
|
||||||
|
|
||||||
Server
|
Misc
|
||||||
-p, --port <number> Web server port
|
-h, --help Print these usage instructions
|
||||||
-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
|
--config Print the stored config
|
||||||
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
|
|
||||||
|
|
||||||
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:
|
||||||
|
Reference in New Issue
Block a user