447e8c7ad5
Also remove link to the demo and use HTTPS to the docs
52 lines
1.4 KiB
Markdown
52 lines
1.4 KiB
Markdown
![#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
|
|
|
|
__What is it?__
|
|
|
|
The Lounge 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 thelounge
|
|
```
|
|
|
|
## Usage
|
|
|
|
When the install is complete, go ahead and run this in your terminal:
|
|
|
|
```
|
|
lounge --help
|
|
```
|
|
|
|
For more information, read the [documentation](https://thelounge.github.io/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
|
|
```
|
|
|
|
## License
|
|
|
|
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/).
|