Shuo/README.md

1.0 KiB

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.