PonyChat's fork of Shout
Go to file
Christine Dodrill 3708c1d593 Shout -> Shuo branding
Closes #16
2015-08-04 17:46:53 -07:00
client Shout -> Shuo branding 2015-08-04 17:46:53 -07:00
defaults Shout -> Shuo branding 2015-08-04 17:46:53 -07:00
src Shout -> Shuo branding 2015-08-04 17:46:53 -07:00
test add basic environment for unit testing with mocha 2014-11-17 22:14:28 +02:00
.gitignore Update gitignore 2014-10-05 01:19:05 -07:00
.travis.yml mend travis for real 2015-08-04 16:37:14 -07:00
CHANGELOG.md Increase process.setMaxListeners 2015-04-29 12:55:34 -07:00
Gruntfile.js Emit topic over socket 2014-10-10 22:05:25 +02:00
README.md update readme, bump package version 2015-08-04 17:33:24 -07:00
index.js Rename cli folder 2014-08-25 02:40:13 -07:00
package.json update readme, bump package version 2015-08-04 17:33:24 -07:00

README.md

Shuo

What is it? Shuo is a web IRC client that you host on your own server. This is PonyChat's fork of Shout, forked due to Shout appearing to be stagnant.

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
  • .. and more!

Install

sudo npm install -g shuo

Usage

When the install is complete, go ahead and run this in your terminal:

shuo --help

For more information, read the documentation.

Development setup

To run the app from source, just clone the code and run this in your terminal:

npm install
grunt
./index.js --port 8080

And if you don't have grunt installed already, just run npm install -g grunt-cli.

License

Available under the MIT license.