Browse Source

docs

master
Lloyd Brookes 10 years ago
parent
commit
b0494e45ee
  1. 10
      README.md
  2. 4
      bin/ws.js

10
README.md

@ -22,7 +22,9 @@ $ npm install -g local-web-server
Usage
-----
```
ws [--directory|-d <directory>] [--port|-p <port>] [--log-format|-f dev|default|short|tiny] [--compress|-c]
$ ws [--directory|-d <directory>] [--port|-p <port>] [--log-format|-f dev|default|short|tiny] [--compress|-c]
$ ws --config
$ ws --help|-h
```
From the folder you wish to serve, run:
@ -83,6 +85,12 @@ Or store global defaults in a `.local-web-server.json` file in your home directo
All stored defaults are overriden by options supplied at the command line.
To view your stored defaults, run:
```sh
$ ws --config
```
Use with Logstalgia
-------------------
The "default" log-format is compatible with [logstalgia](http://code.google.com/p/logstalgia/).

4
bin/ws.js

@ -14,8 +14,8 @@ var dope = require("console-dope"),
var usage =
"usage: \n\
$ ws [--directory|-d <directory>] [--port|-p <port>] [--log-format|-f dev|default|short|tiny]\n\
$ ws --compress|-c \n\
$ ws [--directory|-d <directory>] [--port|-p <port>] [--log-format|-f dev|default|short|tiny] [--compress|-c]\n\
$ ws --config\n\
$ ws --help|-h";
function halt(message){

Loading…
Cancel
Save