2014-08-02 14:13:58 +02:00
|
|
|
# Shout [](https://www.npmjs.org/package/shout)
|
2014-07-21 01:14:36 +02:00
|
|
|
|
2014-10-01 21:10:14 +02:00
|
|
|
### [Try the Demo](http://demo.shout-irc.com/)
|
|
|
|
|
|
2014-08-18 14:50:12 +02: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 14:55:27 +02:00
|
|
|
- _.. and more!_
|
2014-08-18 14:50:12 +02:00
|
|
|
|
2014-07-21 01:14:36 +02:00
|
|
|
## Install
|
|
|
|
|
|
2014-08-13 03:27:53 +02:00
|
|
|
```
|
|
|
|
|
sudo npm install -g shout
|
|
|
|
|
```
|
2014-07-21 01:14:36 +02:00
|
|
|
|
2014-08-13 03:27:53 +02:00
|
|
|
## Usage
|
2014-07-21 01:14:36 +02:00
|
|
|
|
2014-09-30 20:18:31 +02:00
|
|
|
When the install is complete, go ahead and run this in your terminal:
|
2014-08-18 18:53:17 -07:00
|
|
|
|
2014-08-17 17:40:28 +02:00
|
|
|
```
|
|
|
|
|
shout --help
|
2014-08-13 03:27:53 +02:00
|
|
|
```
|
2014-07-21 01:14:36 +02:00
|
|
|
|
2014-09-30 20:21:03 +02:00
|
|
|
For more information, read the [documentation](http://shout-irc.com/docs/).
|
|
|
|
|
|
2015-02-06 12:10:11 +01:00
|
|
|
## Development setup
|
|
|
|
|
|
|
|
|
|
To run the app from source, just clone the code and run this in your terminal:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
npm install
|
2015-03-29 15:42:16 +02:00
|
|
|
grunt
|
|
|
|
|
./index.js --port 8080
|
2015-02-06 12:10:11 +01:00
|
|
|
```
|
|
|
|
|
|
2015-03-29 15:43:58 +02:00
|
|
|
And if you don't have [grunt](http://gruntjs.com/getting-started) installed already, just run `npm install -g grunt-cli`.
|
|
|
|
|
|
2014-07-21 01:14:36 +02:00
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
Available under [the MIT license](http://mths.be/mit).
|
