Shuo/README.md

59 lines
1.0 KiB
Markdown
Raw Normal View History

2014-08-02 12:13:58 +00:00
# Shout [![](https://badge.fury.io/js/shout.png)](https://www.npmjs.org/package/shout)
2014-07-20 23:14:36 +00:00
Run your IRC client on a server and access it from the web browser. This allows you to chat from multiple devices at the same time and you will stay connected to IRC even when you close your browser.
2014-08-05 08:44:21 +00:00
### [Try the Shout client](http://shout-irc.com:9090/)
2014-07-20 23:14:36 +00:00
## Install
2014-08-13 01:27:53 +00:00
```
sudo npm install -g shout
```
2014-07-20 23:14:36 +00:00
2014-08-13 01:27:53 +00:00
## Usage
2014-07-20 23:14:36 +00:00
2014-08-13 01:27:53 +00:00
When the install is complete, go ahead and start the server:
2014-07-20 23:14:36 +00:00
2014-08-13 01:27:53 +00:00
```
shout start --port 9000
```
2014-07-20 23:14:36 +00:00
2014-08-13 01:27:53 +00:00
## Screenshots
2014-07-20 23:14:36 +00:00
2014-08-13 01:27:53 +00:00
![](https://raw.github.com/erming/shout/master/screenshots/shout.png)
2014-07-20 23:14:36 +00:00
### Commands
These are the commands currently implemented:
- [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] /raw
- [x] /say
- [x] /send
- [x] /server
- [x] /slap
- [x] /topic
- [x] /voice
- [x] /whois
## License
Available under [the MIT license](http://mths.be/mit).