8bf438992a
add development setup instructions, thanks @hennevogel, fix #355 |
||
---|---|---|
client | ||
defaults | ||
src | ||
test | ||
.gitignore | ||
.travis.yml | ||
CHANGELOG.md | ||
Gruntfile.js | ||
README.md | ||
index.js | ||
package.json |
README.md
Shout
Try the Demo
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
- .. and more!
Install
sudo npm install -g shout
Usage
When the install is complete, go ahead and run this in your terminal:
shout --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 build
node index.js
License
Available under the MIT license.