cadey
/
Shuo
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README.md

This commit is contained in:
Mattias Erming 2014-08-17 17:40:28 +02:00
parent 8dbd1b4d3f
commit 6b0575f191
1 changed files with 20 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -15,14 +15,31 @@ sudo npm install -g shout
When the install is complete, go ahead and start the server: When the install is complete, go ahead and start the server:
``` ```
shout --port 9000 shout
```
For more information:
```
shout --help
``` ```
## Screenshot ## Screenshot
![](https://raw.github.com/erming/shout/master/screenshots/shout.png) ![](https://raw.github.com/erming/shout/master/screenshots/shout.png)
### Commands ## Configuration
Open your `config.json` file and edit:
__port__
The default port to be used.
You can override this by running `shout --port 80`
__public__
Set to either `true|false`.
When set to `false`, a login will be required for connecting users.
## Commands
These are the commands currently implemented: These are the commands currently implemented: