thelounge_ynh/README.md

<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->

# The Lounge for YunoHost

[![Integration level](https://dash.yunohost.org/integration/thelounge.svg)](https://dash.yunohost.org/appci/app/thelounge) ![Working status](https://ci-apps.yunohost.org/ci/badges/thelounge.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/thelounge.maintain.svg)

[![Install The Lounge with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=thelounge)

*[Lire ce readme en français.](./README_fr.md)*

> *This package allows you to install The Lounge quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*

## Overview

Modern web IRC client designed for self-hosting 

### Features:

- Always connected
- Responsive interface
- Multi-user support

**Shipped version:** 4.4.1~ynh2

**Demo:** https://demo.thelounge.chat/

## Screenshots

![Screenshot of The Lounge](./doc/screenshots/thelounge-screenshot.png)

## Documentation and resources

* Official app website: <https://thelounge.chat/>
* Official admin documentation: <https://thelounge.chat/docs>
* Upstream app code repository: <https://github.com/thelounge/thelounge>
* YunoHost Store: <https://apps.yunohost.org/app/thelounge>
* Report a bug: <https://github.com/YunoHost-Apps/thelounge_ynh/issues>

## Developer info

Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/thelounge_ynh/tree/testing).

To try the testing branch, please proceed like that.

``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/thelounge_ynh/tree/testing --debug
or
sudo yunohost app upgrade thelounge -u https://github.com/YunoHost-Apps/thelounge_ynh/tree/testing --debug
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>