diff --git a/ALL_README.md b/ALL_README.md new file mode 100644 index 0000000..d6e8f9c --- /dev/null +++ b/ALL_README.md @@ -0,0 +1,4 @@ +# All available README files by language + +- [Read the README in English](README.md) +- [Lire le README en français](README_fr.md) diff --git a/README.md b/README.md index 0df7097..50cc9cd 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -9,16 +9,17 @@ It shall NOT be edited by hand. [![Install ntfy with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ntfy) -*[Lire ce readme en français.](./README_fr.md)* +*[Read this README is other languages.](./ALL_README.md)* -> *This package allows you to install ntfy 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.* +> *This package allows you to install ntfy 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 ntfy (pronounce: *notify*) is a simple HTTP-based pub-sub notification service. It allows you to send notifications to your phone or desktop via scripts from any computer, entirely without signup, cost or setup. It's also open source if you want to run your own. -**Shipped version:** 2.9.0~ynh1 + +**Shipped version:** 2.10.0~ynh1 **Demo:** ## Documentation and resources @@ -32,9 +33,9 @@ ntfy (pronounce: *notify*) is a simple HTTP-based pub-sub notification service. ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/ntfy_ynh/tree/testing). +Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/ntfy_ynh/tree/testing). -To try the testing branch, please proceed like that. +To try the `testing` branch, please proceed like that: ```bash sudo yunohost app install https://github.com/YunoHost-Apps/ntfy_ynh/tree/testing --debug diff --git a/README_fr.md b/README_fr.md index 434bcd4..6b5774e 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,6 +1,6 @@ # ntfy pour YunoHost @@ -9,31 +9,32 @@ It shall NOT be edited by hand. [![Installer ntfy avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ntfy) -*[Read this readme in english.](./README.md)* +*[Lire le README dans d'autres langues.](./ALL_README.md)* -> *Ce package vous permet d’installer ntfy 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.* +> *Ce package vous permet d’installer ntfy rapidement et simplement sur un serveur YunoHost.* +> *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.* ## Vue d’ensemble ntfy (prononcer : *notify*) est un simple service de notification pub-sub basé sur HTTP. Il vous permet d'envoyer des notifications sur votre téléphone ou votre ordinateur via des scripts depuis n'importe quel ordinateur, sans inscription, sans frais ni configuration. Il est également open source si vous souhaitez exécuter le vôtre. -**Version incluse :** 2.9.0~ynh1 -**Démo :** +**Version incluse :** 2.10.0~ynh1 + +**Démo :** ## Documentations et ressources -- Site officiel de l’app : -- Documentation officielle utilisateur : -- Documentation officielle de l’admin : -- Dépôt de code officiel de l’app : -- YunoHost Store : -- Signaler un bug : +- Site officiel de l’app : +- Documentation officielle utilisateur : +- Documentation officielle de l’admin : +- Dépôt de code officiel de l’app : +- YunoHost Store : +- Signaler un bug : ## Informations pour les développeurs -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/ntfy_ynh/tree/testing). +Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/ntfy_ynh/tree/testing). -Pour essayer la branche testing, procédez comme suit. +Pour essayer la branche `testing`, procédez comme suit : ```bash sudo yunohost app install https://github.com/YunoHost-Apps/ntfy_ynh/tree/testing --debug @@ -41,4 +42,4 @@ ou sudo yunohost app upgrade ntfy -u https://github.com/YunoHost-Apps/ntfy_ynh/tree/testing --debug ``` -**Plus d’infos sur le packaging d’applications :** +**Plus d’infos sur le packaging d’applications :**