diff --git a/README.md b/README.md index 06b81d1..2c7b512 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ It shall NOT be edited by hand. # Miniflux for YunoHost -[![Integration level](https://dash.yunohost.org/integration/miniflux.svg)](https://dash.yunohost.org/appci/app/miniflux) ![](https://ci-apps.yunohost.org/ci/badges/miniflux.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/miniflux.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/miniflux.svg)](https://dash.yunohost.org/appci/app/miniflux) ![Working status](https://ci-apps.yunohost.org/ci/badges/miniflux.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/miniflux.maintain.svg) [![Install Miniflux with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=miniflux) *[Lire ce readme en français.](./README_fr.md)* @@ -19,11 +19,9 @@ Minimalist and opinionated RSS feed reader **Shipped version:** 2.0.36~ynh1 - - ## Screenshots -![](./doc/screenshots/overview.png) +![Screenshot of Miniflux](./doc/screenshots/overview.png) ## Disclaimers / important information @@ -32,21 +30,22 @@ Minimalist and opinionated RSS feed reader You can also configure Miniflux by editing this file `/var/www/miniflux/miniflux.conf` using the [documentation](https://miniflux.app/docs/configuration.html). ## Documentation and resources -* Official app website: https://miniflux.app/ -* Official admin documentation: https://miniflux.app/docs/index.html -* Upstream app code repository: https://github.com/miniflux/v2 -* YunoHost documentation for this app: https://yunohost.org/app_miniflux -* Report a bug: https://github.com/YunoHost-Apps/miniflux_ynh/issues +* Official app website: +* Official admin documentation: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/miniflux_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/miniflux_ynh/tree/testing --debug or sudo yunohost app upgrade miniflux -u https://github.com/YunoHost-Apps/miniflux_ynh/tree/testing --debug ``` -**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index 7ac2518..2a59654 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,10 +1,14 @@ + + # Miniflux pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/miniflux.svg)](https://dash.yunohost.org/appci/app/miniflux) ![](https://ci-apps.yunohost.org/ci/badges/miniflux.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/miniflux.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/miniflux.svg)](https://dash.yunohost.org/appci/app/miniflux) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/miniflux.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/miniflux.maintain.svg) [![Installer Miniflux avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=miniflux) *[Read this readme in english.](./README.md)* -*[Lire ce readme en français.](./README_fr.md)* > *Ce package vous permet d'installer Miniflux 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.* @@ -15,11 +19,9 @@ Minimalist and opinionated RSS feed reader **Version incluse :** 2.0.36~ynh1 - - ## Captures d'écran -![](./doc/screenshots/overview.png) +![Capture d'écran de Miniflux](./doc/screenshots/overview.png) ## Avertissements / informations importantes @@ -28,21 +30,22 @@ Minimalist and opinionated RSS feed reader Vous pouvez configurer Miniflux en modifiant le fichier `/var/www/miniflux/miniflux.conf` en vous aidant de la [documentation](https://miniflux.app/docs/configuration.html). ## Documentations et ressources -* Site officiel de l'app : https://miniflux.app/ -* Documentation officielle de l'admin : https://miniflux.app/docs/index.html -* Dépôt de code officiel de l'app : https://github.com/miniflux/v2 -* Documentation YunoHost pour cette app : https://yunohost.org/app_miniflux -* Signaler un bug : https://github.com/YunoHost-Apps/miniflux_ynh/issues +* 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/miniflux_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/miniflux_ynh/tree/testing --debug ou sudo yunohost app upgrade miniflux -u https://github.com/YunoHost-Apps/miniflux_ynh/tree/testing --debug ``` -**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file +**Plus d'infos sur le packaging d'applications :**