Update README.md
This commit is contained in:
Mattias Erming
parent
81862176a2
commit
9681ec506a
115
README.md
115
README.md
|
|
@ -10,12 +10,7 @@ __What features does it have?__
|
||||||
- Responsive layout — works well on your smartphone
|
- Responsive layout — works well on your smartphone
|
||||||
- _.. and more!_
|
- _.. and more!_
|
||||||
|
|
||||||
__Ok, you caught my attention. I want to try it!__
|
#### [Try the Demo](http://demo.shout-irc.com/)
|
||||||
Here's a Shout server running in public mode, which allows for anonymous connections:
|
|
||||||
|
|
||||||
### [Try the Demo](http://demo.shout-irc.com/)
|
|
||||||
|
|
||||||
_Clicking the link above will open http://demo.shout-irc.com/_
|
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
|
|
@ -25,118 +20,12 @@ sudo npm install -g shout
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
When the install is complete, go ahead and start the server:
|
When the install is complete, go ahead and run this in your terminal:
|
||||||
|
|
||||||
```
|
|
||||||
shout
|
|
||||||
```
|
|
||||||
|
|
||||||
For more information:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
shout --help
|
shout --help
|
||||||
```
|
```
|
||||||
|
|
||||||
## Screenshot
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
Open the `config.json` file by running:
|
|
||||||
|
|
||||||
```
|
|
||||||
shout config
|
|
||||||
```
|
|
||||||
|
|
||||||
The settings:
|
|
||||||
|
|
||||||
__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.
|
|
||||||
|
|
||||||
|
|
||||||
## User Management
|
|
||||||
|
|
||||||
Go ahead and run `shout --help`:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ shout --help
|
|
||||||
|
|
||||||
Usage: shout [options] [command]
|
|
||||||
|
|
||||||
Commands:
|
|
||||||
|
|
||||||
start
|
|
||||||
Start the server
|
|
||||||
|
|
||||||
config
|
|
||||||
Edit config: '/usr/lib/node_modules/shout/config.json'
|
|
||||||
|
|
||||||
list
|
|
||||||
List all existing users
|
|
||||||
|
|
||||||
add <name>
|
|
||||||
Add a new user
|
|
||||||
|
|
||||||
remove <name>
|
|
||||||
Remove an existing user
|
|
||||||
|
|
||||||
reset <name>
|
|
||||||
Reset user password
|
|
||||||
|
|
||||||
edit <name>
|
|
||||||
Edit user: '/home/erming/.shout/users/<name>/user.json'
|
|
||||||
|
|
||||||
|
|
||||||
Options:
|
|
||||||
|
|
||||||
-h, --help output usage information
|
|
||||||
-h, --host <ip> host
|
|
||||||
-p, --port <port> port
|
|
||||||
```
|
|
||||||
|
|
||||||
Pretty simple, huh?
|
|
||||||
|
|
||||||
If you want to edit users manually, see `users/example/user.json`.
|
|
||||||
|
|
||||||
## Commands
|
|
||||||
|
|
||||||
These are the commands currently implemented:
|
|
||||||
|
|
||||||
- [x] /clear
|
|
||||||
- [x] /close
|
|
||||||
- [x] /connect
|
|
||||||
- [x] /deop
|
|
||||||
- [x] /devoice
|
|
||||||
- [x] /disconnect
|
|
||||||
- [x] /invite
|
|
||||||
- [x] /join
|
|
||||||
- [x] /kick
|
|
||||||
- [x] /leave
|
|
||||||
- [x] /me
|
|
||||||
- [x] /mode
|
|
||||||
- [x] /msg
|
|
||||||
- [x] /nick
|
|
||||||
- [x] /notice
|
|
||||||
- [x] /op
|
|
||||||
- [x] /part
|
|
||||||
- [x] /query
|
|
||||||
- [x] /quit
|
|
||||||
- [x] /quote
|
|
||||||
- [x] /raw
|
|
||||||
- [x] /say
|
|
||||||
- [x] /send
|
|
||||||
- [x] /server
|
|
||||||
- [x] /slap
|
|
||||||
- [x] /topic
|
|
||||||
- [x] /voice
|
|
||||||
- [x] /whois
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Available under [the MIT license](http://mths.be/mit).
|
Available under [the MIT license](http://mths.be/mit).
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue