Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
andrewdavey committed Jan 1, 2011
1 parent f4b256a commit 1c54407
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions readme
Expand Up @@ -2,3 +2,21 @@ Vogue

Copyright (c) 2011 Andrew Davey (andrew@equin.co.uk)
MIT License

Vogue creates a real-time link between your web browser and your file system. When you save
a CSS file, used by the HTML page in your browser, Vogue will make the browser reload the
stylesheet. Only the stylesheet is reloaded, not the entire page, making it work even for
very dynamic/ajax pages.

Vogue is all javascript. There is a server running on Node.js, which will watch the file
system. The server accepts WebSocket connections from the client code (which uses socket.io).
The client javascript can be loaded into a HTML page using a single <script> tag.

Run the Vogue server using node.
node vogue.js -dir /path/to/website -port 8001

-dir is optional, defaults to the current directory.
-port is optional, defaults to 8001.

Open http://localhost:8001/ to see instructions for loading the Vogue client into your
web pages.

0 comments on commit 1c54407

Please sign in to comment.