mirror of
https://github.com/YunoHost-Apps/kiwiirc_ynh.git
synced 2024-09-03 19:35:59 +02:00
58 lines
No EOL
2.2 KiB
Markdown
58 lines
No EOL
2.2 KiB
Markdown
<!--
|
|
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
|
|
|
|
[](https://dash.yunohost.org/appci/app/kiwiirc)  
|
|
[](https://install-app.yunohost.org/?app=kiwiirc)
|
|
|
|
*[Lire ce readme en français.](./README_fr.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.5.0~ynh1
|
|
|
|
**Demo:** https://kiwiirc.com/nextclient
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## Documentation and resources
|
|
|
|
* Official app website: https://kiwiirc.com/
|
|
* Official user documentation: https://yunohost.org/apps
|
|
* Official admin documentation: https://github.com/kiwiirc/kiwiirc/wiki
|
|
* Upstream app code repository: https://github.com/kiwiirc/kiwiirc
|
|
* YunoHost documentation for this app: https://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.
|
|
```
|
|
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 |