From 90e17d3ae4cb75de4af405a5b8d4ada57b2efcab Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Thu, 28 Jul 2022 22:43:38 +0000 Subject: [PATCH] Auto-update README --- README.md | 52 +++++++++++++++++++++++++++------------------------- README_fr.md | 46 ++++++++++++++++++++++++---------------------- 2 files changed, 51 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index 6b72f21..c07a60b 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,54 @@ + + # Gotify for YunoHost -[![Integration level](https://dash.yunohost.org/integration/gotify.svg)](https://dash.yunohost.org/appci/app/gotify) ![](https://ci-apps.yunohost.org/ci/badges/gotify.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/gotify.maintain.svg) -[![Install Gotify with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=gotify) +[![Integration level](https://dash.yunohost.org/integration/gotify.svg)](https://dash.yunohost.org/appci/app/gotify) ![Working status](https://ci-apps.yunohost.org/ci/badges/gotify.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/gotify.maintain.svg) +[![Install Gotify with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gotify) *[Lire ce readme en français.](./README_fr.md)* -> *This package allow you to install Gotify quickly and simply on a YunoHost server. -If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* +> *This package allows you to install Gotify 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 + Gotify is a simple server for sending and receiving messages in real-time per web socket. (Includes a sleek web-ui) -**Shipped version:** 2.1.4 + +**Shipped version:** 2.1.4~ynh2 ## Screenshots -[![Screenshot](https://raw.githubusercontent.com/gotify/server/master/ui.png)](https://github.com/gotify/server) +![Screenshot of Gotify](./doc/screenshots/ui.png) + +## Disclaimers / important information ## Configuration How to configure this app: > Edit `config.yml` file via SSH. -## Documentation +## Documentation and resources - * Official documentation: https://gotify.net/docs/index - * YunoHost documentation: https://yunohost.org/#/app_gotify +* Official app website: +* Official admin documentation: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: -#### Multi-users support +## Developer info -LDAP is not supported (blocked until Gotify core upstream implements it). - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/gotify_ynh/issues - * App website: https://gotify.net/ - * Upstream app repository: https://github.com/gotify/server - * YunoHost website: https://yunohost.org/ - ---- - -## Developers info - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/gotify_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/gotify_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/gotify_ynh/tree/testing --debug or sudo yunohost app upgrade gotify -u https://github.com/YunoHost-Apps/gotify_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index 2511267..b4b206c 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,52 +1,54 @@ + + # Gotify pour YunoHost -[![Integration level](https://dash.yunohost.org/integration/gotify.svg)](https://dash.yunohost.org/appci/app/gotify) ![](https://ci-apps.yunohost.org/ci/badges/gotify.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/gotify.maintain.svg) -[![Install Gotify with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=gotify) +[![Niveau d'intégration](https://dash.yunohost.org/integration/gotify.svg)](https://dash.yunohost.org/appci/app/gotify) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/gotify.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/gotify.maintain.svg) +[![Installer Gotify avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gotify) *[Read this readme in english.](./README.md)* -> *Ce package vous permet d'installer Gotify rapidement et simplement sur un serveur Yunohost. +> *Ce package vous permet d'installer Gotify 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 + Gotify est un serveur simple permettant d'envoyer et de recevoir des messages via websocket. -**Version incluse :** 2.1.4 + +**Version incluse :** 2.1.4~ynh2 ## Captures d'écran -[![Screenshot](https://raw.githubusercontent.com/gotify/server/master/ui.png)](https://github.com/gotify/server) +![Capture d'écran de Gotify](./doc/screenshots/ui.png) + +## Avertissements / informations importantes ## Configuration Pour configurer Gotify : > Éditer le fichier `config.yml` avec SSH. -## Documentation +## Documentations et ressources - * Documentation officielle : https://gotify.net/docs/index - * Documentation YunoHost : https://yunohost.org/#/app_gotify_fr - -#### Support multi-utilisateurs - -Pas de support de LDAP (non implémenté upstream) - -## Liens - - * Signaler un bug : https://github.com/YunoHost-Apps/gotify_ynh/issues - * Site de l'application : https://gotify.net/ - * Dépôt de l'application principale : https://github.com/gotify/server - * Site web YunoHost : https://yunohost.org/ - ---- +* Site officiel de l'app : +* Documentation officielle de l'admin : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/gotify_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/gotify_ynh/tree/testing --debug ou sudo yunohost app upgrade gotify -u https://github.com/YunoHost-Apps/gotify_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :**