diff --git a/README.md b/README.md index 86767e4..13eac8d 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,38 @@ + + # KiwiIRC for YunoHost [![Integration level](https://dash.yunohost.org/integration/kiwiirc.svg)](https://dash.yunohost.org/appci/app/kiwiirc) ![](https://ci-apps.yunohost.org/ci/badges/kiwiirc.status.svg) ![](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) +[![Install KiwiIRC with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](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. +> *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 -HedgeDoc is a real-time collaborative word processing web service. It uses Markdown language. -**Shipped version:** 1.5.0 +A versatile web based messenger using IRC + +**Shipped version:** 1.5.0~ynh1 + +**Demo:** https://kiwiirc.com/nextclient ## Screenshots -![]() +![](./doc/screenshots/screenshot.png) -## Demo +## Documentation and resources -* [Official demo]() - -## Configuration - - -## Documentation - - * Official documentation: https://github.com/kiwiirc/kiwiirc/wiki - * YunoHost documentation: - -## YunoHost specific features - -#### Multi-user support - -* Is LDAP supported? **Yes** -* Can the app be used by multiple users? **Yes** - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/kiwiirc%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/kiwiirc/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/kiwiirc%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/kiwiirc/) - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/kiwiirc_ynh/issues - * Upstream app repository: https://github.com/kiwiirc/kiwiirc - * YunoHost website: https://yunohost.org/ - ---- +* 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 @@ -59,3 +44,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/kiwiirc_ynh/tree/test 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 \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index 80aad2d..8455287 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,52 +1,34 @@ # KiwiIRC pour YunoHost [![Niveau d'intégration](https://dash.yunohost.org/integration/kiwiirc.svg)](https://dash.yunohost.org/appci/app/kiwiirc) ![](https://ci-apps.yunohost.org/ci/badges/kiwiirc.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/kiwiirc.maintain.svg) -[![Installer HedgeDoc avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=kiwiirc) +[![Installer KiwiIRC avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=kiwiirc) -*[Read this readme in english.](./README.md)* +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d'installer HedgeDoc rapidement et simplement sur un serveur YunoHost. -Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.* +> *Ce package vous permet d'installer KiwiIRC rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* ## Vue d'ensemble -HedgeDoc est un service web de traitement de texte collaboratif en temps réel. Il utilise le langage Markdown. -**Version incluse :** 1.5.0 +Une messagerie Web polyvalente utilisant IRC + +**Version incluse :** 1.5.0~ynh1 + +**Démo :** https://kiwiirc.com/nextclient ## Captures d'écran -![]() +![](./doc/screenshots/screenshot.png) -## Démo +## Documentations et ressources -* [Démo officielle]() - -## Configuration - -## Documentation - - * Documentation officielle : https://github.com/kiwiirc/kiwiirc/wiki - * Documentation YunoHost : - -## Caractéristiques spécifiques YunoHost - -#### Support multi-utilisateur - -* L'authentification LDAP est-elle prise en charge ? **Oui** -* L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui** - -#### Architectures supportées - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/kiwiirc%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/kiwiirc/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/kiwiirc%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/kiwiirc/) - -## Liens - - * Signaler un bug : https://github.com/YunoHost-Apps/kiwiirc_ynh/issues - * Dépôt de l'application principale : https://github.com/kiwiirc/kiwiirc - * Site web YunoHost : https://yunohost.org/ - ---- +* Site officiel de l'app : https://kiwiirc.com/ +* Documentation officielle utilisateur : https://yunohost.org/apps +* Documentation officielle de l'admin : https://github.com/kiwiirc/kiwiirc/wiki +* Dépôt de code officiel de l'app : https://github.com/kiwiirc/kiwiirc +* Documentation YunoHost pour cette app : https://yunohost.org/app_kiwiirc +* Signaler un bug : https://github.com/YunoHost-Apps/kiwiirc_ynh/issues ## Informations pour les développeurs @@ -58,3 +40,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/kiwiirc_ynh/tree/test ou sudo yunohost app upgrade kiwiirc -u https://github.com/YunoHost-Apps/kiwiirc_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file