Shuo/README.md

34 lines
729 B
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
2014-10-01 19:10:14 +00:00
### [Try the Demo](http://demo.shout-irc.com/)
2014-08-18 12:50:12 +00:00
__What is it?__
Shout is a web IRC client that you host on your own server.
__What features does it have?__
- Multiple user support
- Stays connected even when you close the browser
- Connect from multiple devices at once
- Responsive layout — works well on your smartphone
2014-08-18 12:55:27 +00:00
- _.. and more!_
2014-08-18 12:50:12 +00:00
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-09-30 18:18:31 +00:00
When the install is complete, go ahead and run this in your terminal:
2014-08-19 01:53:17 +00:00
2014-08-17 15:40:28 +00:00
```
shout --help
2014-08-13 01:27:53 +00:00
```
2014-07-20 23:14:36 +00:00
2014-09-30 18:21:03 +00:00
For more information, read the [documentation](http://shout-irc.com/docs/).
2014-07-20 23:14:36 +00:00
## License
Available under [the MIT license](http://mths.be/mit).