Shuo/README.md

47 lines
1.0 KiB
Markdown
Raw Normal View History

2015-08-04 22:50:07 +00:00
# Shuo [![](https://badge.fury.io/js/shout.png)](https://www.npmjs.org/package/shout)
2014-07-20 23:14:36 +00:00
2015-08-04 22:50:07 +00:00
__What is it?__
Shuo is a web IRC client that you host on your own server. This is PonyChat's
fork of [Shout](https://github.com/erming/shout), forked due to Shout appearing
to be stagnant.
2014-10-01 19:10:14 +00:00
2015-08-04 22:50:07 +00:00
__What features does it have?__
2014-08-18 12:50:12 +00:00
- 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/).
## Development setup
To run the app from source, just clone the code and run this in your terminal:
```
npm install
2015-03-29 13:42:16 +00:00
grunt
./index.js --port 8080
```
2015-08-04 22:50:07 +00:00
And if you don't have [grunt](http://gruntjs.com/getting-started) installed
already, just run `npm install -g grunt-cli`.
2015-03-29 13:43:58 +00:00
2014-07-20 23:14:36 +00:00
## License
Available under [the MIT license](http://mths.be/mit).