diff --git a/README.md b/README.md index a4cfdd2..61c566a 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,54 @@ + + +--- + + + # 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) -[![Install Miniflux with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=miniflux/) +[![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) +[![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)* -> *This package allows you to install Miniflux 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 miniflux 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 -Miniflux is a minimalist and opinionated feed reader. +Minimalist and opinionated RSS feed reader + +**Shipped version:** 2.0.30~ynh1 + + -**Shipped version:** 2.0.30 ## Screenshots -![](https://miniflux.app/images/overview.png) + + ![](./doc/screenshots/overview.png) + + + + +## Disclaimers / important information ## Configuration You can also configure Miniflux by editing this file `/var/www/miniflux/miniflux.conf` using the [documentation](https://miniflux.app/docs/configuration.html). -## Documentation - * Official documentation: https://miniflux.app/docs/index.html +## Documentation and resources -## YunoHost specific features +* Official app website: https://miniflux.app/ -#### Multi-user support - -* Is LDAP supported? **No** -* Can the app be used by multiple users? **No** - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/miniflux.svg)](https://ci-apps.yunohost.org/ci/apps/miniflux/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/miniflux.svg)](https://ci-apps-arm.yunohost.org/ci/apps/miniflux/) - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/miniflux_ynh/issues - * Upstream app repository: https://github.com/miniflux/v2 - * YunoHost website: https://yunohost.org/ - ---- +* 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 ## Developer info @@ -56,3 +60,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/miniflux_ynh/tree/tes 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 diff --git a/README_fr.md b/README_fr.md index d88f870..d96e902 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,50 +1,46 @@ # 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) -[![Installer Miniflux avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=miniflux) +[![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) +[![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)* +*[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, consultez [le guide](https://yunohost.org/install) pour apprendre comment l'installer.* +> *This package allows you to install miniflux 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.* ## Vue d'ensemble -Miniflux est un agrégateur de flux RSS minimaliste. +Agrégateur de flux RSS minimaliste + +**Version incluse:** 2.0.30~ynh1 + + -**Version incluse :** 2.0.30 ## Captures d'écran -![](https://miniflux.app/images/overview.png) + + ![](./doc/screenshots/overview.png) + + + + +## Avertissements / informations importantes ## Configuration 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). -## Documentation - * Documentation officielle : https://miniflux.app/docs/index.html +## Documentations et ressources -## Caractéristiques spécifiques YunoHost +* Site official de l'app : https://miniflux.app/ -#### Support multi-utilisateur - -* L'authentification LDAP est-elle prise en charge ? **Non** -* L'application peut-elle être utilisée par plusieurs utilisateurs ? **Non** - -#### Architectures supportées - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/miniflux.svg)](https://ci-apps.yunohost.org/ci/apps/miniflux/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/miniflux.svg)](https://ci-apps-arm.yunohost.org/ci/apps/miniflux/) - -## Liens - - * Signaler un bug : https://github.com/YunoHost-Apps/miniflux_ynh/issues - * Dépôt de l'application principale : https://github.com/miniflux/v2 - * Site web YunoHost : https://yunohost.org/ - ---- +* 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 ## Informations pour les développeurs @@ -53,6 +49,8 @@ Merci de faire vos pull request sur la [branche testing](https://github.com/Yuno Pour essayer la branche testing, procédez comme suit. ``` 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/tree/testing --debug +or +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