hardlounge/README.md

52 lines
1.4 KiB
Markdown
Raw Normal View History

![#thelounge IRC channel on freenode](https://img.shields.io/badge/irc%20channel-%23thelounge%20on%20freenode-blue.svg)
[![npm version](https://img.shields.io/npm/v/thelounge.svg)](https://www.npmjs.org/package/thelounge)
[![Build Status](https://travis-ci.org/thelounge/lounge.svg?branch=master)](https://travis-ci.org/thelounge/lounge)
[![Dependency Status](https://david-dm.org/thelounge/lounge.svg)](https://david-dm.org/thelounge/lounge)
[![devDependency Status](https://david-dm.org/thelounge/lounge/dev-status.svg)](https://david-dm.org/thelounge/lounge#info=devDependencies)
# The Lounge
2014-10-01 19:10:14 +00:00
2015-09-13 21:20:05 +00:00
__What is it?__
The Lounge is a web IRC client that you host on your own server.
2014-08-18 12:50:12 +00:00
2015-09-13 21:20:05 +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 thelounge
2014-08-13 01:27:53 +00:00
```
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
```
lounge --help
2014-08-13 01:27:53 +00:00
```
2014-07-20 23:14:36 +00:00
For more information, read the [documentation](https://thelounge.github.io/docs/).
2014-09-30 18:21:03 +00:00
## 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-20 23:14:36 +00:00
## License
2015-10-06 07:55:30 +00: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/).