From 2ce381eb5d89cd261ac0f98bc7d633f47b87257f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment?= Date: Sun, 10 Mar 2019 17:39:30 +0100 Subject: [PATCH] update README and add french README --- README.md | 19 +++++++++++++--- README_fr.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 77 insertions(+), 3 deletions(-) create mode 100644 README_fr.md diff --git a/README.md b/README.md index 536d040..ae49790 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # Gotify for YunoHost -[![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) +[![Install Gotify with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](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.* @@ -34,8 +36,6 @@ LDAP not supported. * No LDAP support (blocked until Gotify core upstream implements it) - * is_public is ignored app can't be SSOed - ## Links * Report a bug: https://github.com/YunoHost-Apps/gotify_ynh/issues @@ -43,3 +43,16 @@ LDAP not supported. * YunoHost website: https://yunohost.org/ --- + +Developers info +---------------- + +**Only if you want to use a testing branch for coding, instead of merging directly into master.** +Please do 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. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/gotify_ynh/tree/testing --debug +or +sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/gotify_ynh/tree/testing --debug +``` diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..56e5ead --- /dev/null +++ b/README_fr.md @@ -0,0 +1,61 @@ +# Gotify pour YunoHost + +[![Integration level](https://dash.yunohost.org/integration/gotify.svg)](https://dash.yunohost.org/appci/app/gotify) +[![Install Gotify with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](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. +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 simple serveur permettant d'envoyer et de recevoir des messages via websocket. + +**Version incluse:** 2.0.2 + +## Captures d'écran + +[![Screenshot](https://raw.githubusercontent.com/gotify/server/master/ui.png)](https://github.com/gotify/server) + +## Configuration + +Pour configurer Gotify : +> Edit config.yml file via SSH. + +## Documentation + + * Documentation officielle: [ici](https://gotify.net/docs/index) + +#### Support multi-utilisateurs + +Pas de support de LDAP + +## Limitations + + * necessite un domaine dédié par exemple gotify.domain.tld. + + * Pas de support de LDAP (non implémenté upstream) + +## Links + +## Links + + * Signaler un bug: https://github.com/YunoHost-Apps/gotify_ynh/issues + * Site de l'application: https://gotify.net/ + * Site web YunoHost: https://yunohost.org/ + +--- + +Informations pour les développeurs +---------------- + +**Seulement si vous voulez utiliser une branche de test pour le codage, au lieu de fusionner directement dans la banche principale.** +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. +``` +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 +```