Browse Source

Add readme

master
Brett Langdon 8 years ago
parent
commit
3f02d08f99
No known key found for this signature in database GPG Key ID: B664881177781B04
1 changed files with 48 additions and 0 deletions
  1. +48
    -0
      README.md

+ 48
- 0
README.md View File

@ -0,0 +1,48 @@
# LiveReload Server
[LiveReload](http://livereload.com/) static file server that also injects [livereload-js](https://github.com/livereload/livereload-js) into any HTML files.
## Installation
```bash
npm install livereload-server
```
## Usage
```
$ livereload-server --help
livereload-server
Positionals:
serve The directory to serve static files from [string]
Options:
--help Show help [boolean]
--version Show version number [boolean]
--bind, -b Host/port for static server to bind to
[string] [default: "127.0.0.1:3000"]
--lrbind, -l Host/port for LiveReload to bind to
[string] [default: "127.0.0.1:35729"]
--watch, -w Directory to watch for changes [array]
```
```bash
# Use default settings and serve static files from current directory
livereload-server
# Explicitly set the path to serve files from
livereload-server path/to/files/
# Explicitly set the directory to watch and path to serve files from
livereload-server --watch path/to/watch/ path/to/files/
# Setting multiple paths to watch
livereload-server --watch path/1/ --watch path/2/ path/to/files/
# Change the port the static server binds to
livereload-server --bind '0.0.0.0:3000'
# Change the port the LiveReload server binds to
livereload-server -lrbind '0.0.0.0:35729'
```

Loading…
Cancel
Save