kiwiirc_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.
-->

# KiwiIRC for YunoHost

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

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

*[Read this README is other languages.](./ALL_README.md)*

> *This package allows you to install KiwiIRC 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

A versatile web based messenger using IRC

### Features:

- For single networks, bouncer hosts, or a personal generic IRC client that remembers your networks
- Works out of the box with a default IRC network - or use your own
- Single or multiple IRC network connections
- Light and dark modes
- Desktop notifications
- Extremely versatile via a single JSON config file at runtime


**Shipped version:** 1.7.1~ynh1

**Demo:** <https://kiwiirc.com/nextclient>

## Screenshots

![Screenshot of KiwiIRC](./doc/screenshots/screenshot.png)

## Documentation and resources

- Official app website: <https://kiwiirc.com/>
- Official admin documentation: <https://github.com/kiwiirc/kiwiirc/wiki>
- Upstream app code repository: <https://github.com/kiwiirc/kiwiirc>
- YunoHost Store: <https://apps.yunohost.org/app/kiwiirc>
- Report a bug: <https://github.com/YunoHost-Apps/kiwiirc_ynh/issues>

## Developer info

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

To try the `testing` branch, please proceed like that:

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

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