thelounge/README.md

51 lines
1.3 KiB
Markdown
Raw Normal View History

![#shout-irc IRC channel on freenode](https://img.shields.io/badge/irc%20channel-%23shout--irc%20on%20freenode-blue.svg)
[![npm version](https://img.shields.io/npm/v/shout.svg)](https://www.npmjs.org/package/shout)
2015-09-13 23:17:09 +02:00
[![Build Status](https://travis-ci.org/erming/shout.svg?branch=master)](https://travis-ci.org/erming/shout)
2015-09-13 23:19:13 +02:00
[![Dependency Status](https://david-dm.org/erming/shout.svg)](https://david-dm.org/erming/shout)
# 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/)
2015-09-13 23:20:05 +02:00
__What is it?__
2014-08-18 14:50:12 +02:00
Shout is a web IRC client that you host on your own server.
2015-09-13 23:20:05 +02:00
__What features does it have?__
2014-08-18 14:50:12 +02: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 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-19 03:53:17 +02: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/).
## Development setup
To run the app from source, just clone the code and run this in your terminal:
```
npm install
npm run build
npm start
```
2014-07-21 01:14:36 +02:00
## License
2015-10-06 09:55:30 +02:00
Available under the [MIT License](http://mths.be/mit).
Some fonts licensed under [SIL OFL](http://scripts.sil.org/OFL) and the [Apache License](http://www.apache.org/licenses/).