From b0494e45ee4352f25ffe360993fc76c520906479 Mon Sep 17 00:00:00 2001 From: Lloyd Brookes Date: Thu, 8 May 2014 16:07:42 +0200 Subject: [PATCH] docs --- README.md | 10 +++++++++- bin/ws.js | 4 ++-- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5a6ac40..0562fee 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,9 @@ $ npm install -g local-web-server Usage ----- ``` -ws [--directory|-d ] [--port|-p ] [--log-format|-f dev|default|short|tiny] [--compress|-c] +$ ws [--directory|-d ] [--port|-p ] [--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/). diff --git a/bin/ws.js b/bin/ws.js index 471ecb5..8a135c3 100755 --- a/bin/ws.js +++ b/bin/ws.js @@ -14,8 +14,8 @@ var dope = require("console-dope"), var usage = "usage: \n\ -$ ws [--directory|-d ] [--port|-p ] [--log-format|-f dev|default|short|tiny]\n\ -$ ws --compress|-c \n\ +$ ws [--directory|-d ] [--port|-p ] [--log-format|-f dev|default|short|tiny] [--compress|-c]\n\ +$ ws --config\n\ $ ws --help|-h"; function halt(message){