Permalink
Browse files

Tidy the options. Add the -g install option.

  • Loading branch information...
1 parent ec09239 commit 7b9d27ae8edaa5c7b5249d8e4630c3b605a9c5b6 @andrewdavey committed Jul 20, 2011
Showing with 6 additions and 4 deletions.
  1. +6 −4 readme.md
View
@@ -15,16 +15,18 @@ The client javascript can be loaded into a HTML page using a single script tag.
Make sure you have Node.JS and [npm](http://npmjs.org/) installed.
Then run:
- npm install vogue
+ npm install vogue -g
## Usage
Run the Vogue server.
vogue --port 8001 /path/to/website
---port : The port used for Vogue's HTTP server. Optional, defaults to 8001.
---rewrite : A rule in the form of "regexp:replacement" (e.g. "v[0-9]/(.*)$:files/\$1" ) to help rewrite urls to filesystem paths.
-Submatches such as $1 will probably need to entered in your shell as \$1 to escape the $.
+`--port` : The port used for Vogue's HTTP server. Optional, defaults to 8001.
+
+`--rewrite` : A rule in the form of "regexp:replacement" (e.g. "v[0-9]/(.*)$:files/\$1" ) to rewrite urls to filesystem paths.
+ Submatches such as $1 will probably need to entered in your shell as \$1 to escape the $.
+
Open http://localhost:8001/ to see instructions for loading the Vogue client into your
web pages.

0 comments on commit 7b9d27a

Please sign in to comment.