2021-07-09 07:43:15 +02:00
|
|
|
<!--
|
|
|
|
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.
|
|
|
|
-->
|
|
|
|
|
2020-10-11 15:21:19 +02:00
|
|
|
# KiwiIRC for YunoHost
|
|
|
|
|
2023-10-31 15:18:21 +01:00
|
|
|
[![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)
|
|
|
|
|
2021-07-09 07:43:15 +02:00
|
|
|
[![Install KiwiIRC with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=kiwiirc)
|
2020-10-11 15:21:19 +02:00
|
|
|
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
|
2021-07-09 07:43:15 +02:00
|
|
|
> *This package allows you to install KiwiIRC quickly and simply on a YunoHost server.
|
2020-10-11 15:21:19 +02:00
|
|
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
2021-07-09 07:43:15 +02:00
|
|
|
A versatile web based messenger using IRC
|
2020-10-11 15:21:19 +02:00
|
|
|
|
2021-09-24 07:43:16 +02:00
|
|
|
### Features:
|
2021-08-30 14:25:02 +02:00
|
|
|
|
|
|
|
- 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
|
|
|
|
|
|
|
|
|
2022-02-03 19:34:30 +01:00
|
|
|
**Shipped version:** 20.05.24.1~ynh1
|
2020-10-11 15:21:19 +02:00
|
|
|
|
2021-07-09 07:43:15 +02:00
|
|
|
**Demo:** https://kiwiirc.com/nextclient
|
2020-10-11 15:21:19 +02:00
|
|
|
|
2021-07-09 07:43:15 +02:00
|
|
|
## Screenshots
|
2020-10-11 15:21:19 +02:00
|
|
|
|
2022-06-15 01:24:53 +02:00
|
|
|
![Screenshot of KiwiIRC](./doc/screenshots/screenshot.png)
|
2020-10-11 15:21:19 +02:00
|
|
|
|
2021-07-09 07:43:15 +02:00
|
|
|
## Documentation and resources
|
2020-10-11 15:21:19 +02:00
|
|
|
|
2022-06-15 01:24:53 +02:00
|
|
|
* Official app website: <https://kiwiirc.com/>
|
|
|
|
* Official admin documentation: <https://github.com/kiwiirc/kiwiirc/wiki>
|
|
|
|
* Upstream app code repository: <https://github.com/kiwiirc/kiwiirc>
|
2023-10-31 15:18:21 +01:00
|
|
|
* YunoHost Store: <https://apps.yunohost.org/app/kiwiirc>
|
2022-06-15 01:24:53 +02:00
|
|
|
* Report a bug: <https://github.com/YunoHost-Apps/kiwiirc_ynh/issues>
|
2020-10-11 15:21:19 +02:00
|
|
|
|
|
|
|
## 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.
|
2022-06-15 01:24:53 +02:00
|
|
|
|
|
|
|
``` bash
|
2020-10-11 15:21:19 +02:00
|
|
|
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
|
|
|
|
```
|
2021-07-09 07:43:15 +02:00
|
|
|
|
2022-06-15 01:24:53 +02:00
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|