diff --git a/README.md b/README.md index 39cf47d..ba45d56 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ + + # Leed for YunoHost [![Integration level](https://dash.yunohost.org/integration/leed.svg)](https://dash.yunohost.org/appci/app/leed) ![](https://ci-apps.yunohost.org/ci/badges/leed.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/leed.maintain.svg) @@ -5,59 +10,37 @@ *[Lire ce readme en français.](./README_fr.md)* -> *This package allow you to install Leed 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 Leed 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 + Leed (short for Light Feed) is a minimalist RSS/ATOM aggregator which offers fast RSS consultation and non-intrusive features. -**Shipped version:** 1.9.0 + +**Shipped version:** 1.9.0~ynh2 + + ## Screenshots -![](http://projet.idleman.fr/leed/data/leed1.jpg) +![](./doc/screenshots/leed1.jpg) -## Demo - -No demo available. +## Disclaimers / important information ## Configuration Use the admin panel of your Leed to configure this app. +## Documentation and resources -## Documentation +* Official app website: http://leed.idleman.fr/ +* Upstream app code repository: http://git.idleman.fr/LeedRSS/Leed +* YunoHost documentation for this app: https://yunohost.org/app_leed +* Report a bug: https://github.com/YunoHost-Apps/leed_ynh/issues -* YunoHost documentation: There no other documentations, feel free to contribute. +## Developer info -## YunoHost specific features - -* Login secured by Fail2Ban - -#### Multi-users support - -Not supported. - -#### Supported architectures - -* x86-64 - [![](https://ci-apps.yunohost.org/ci/logs/leed%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/leed/) -* ARMv8-A - [![](https://ci-apps-arm.yunohost.org/ci/logs/leed%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/leed/) - -## Limitations - -## Additionnal informations - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/leed_ynh/issues - * Leed website: http://leed.idleman.fr/ - * Leed repository: http://git.idleman.fr/LeedRSS/Leed - * YunoHost website: https://yunohost.org/ - ---- - -## Developers infos - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/leed_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/leed_ynh/tree/testing). To try the testing branch, please proceed like that. ``` @@ -65,3 +48,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/leed_ynh/tree/testing or sudo yunohost app upgrade leed -u https://github.com/YunoHost-Apps/leed_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 d3be59b..11bb7e7 100644 --- a/README_fr.md +++ b/README_fr.md @@ -4,62 +4,45 @@ [![Installer Leed avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=leed) *[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d'installer Leed rapidement et simplement sur un serveur YunoHost. -Si vous n'avez pas YunoHost, merci de regarder [ici](https://yunohost.org/#/install_fr) pour savoir comment l'installer et en profiter.* +> *Ce package vous permet d'installer Leed 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 -## Résumé Leed (contraction de Light Feed) est un agrégateur RSS/ATOM minimaliste qui permet la consultation de flux RSS de manière rapide et non intrusive. -**Version embarquée :** 1.9.0 +**Version incluse :** 1.9.0~ynh2 + + ## Captures d'écran -![](http://projet.idleman.fr/leed/data/leed1.jpg) +![](./doc/screenshots/leed1.jpg) -## Démo - -Aucune démo pour cette application. +## Avertissements / informations importantes ## Configuration Utiliser le panneau d'administration de votre Leed pour configurer cette application. -## Documentation +## Documentations et ressources - * Documentation YunoHost : Il n'y a pas d'autre documentation, n'hésitez pas à contribuer. +* Site officiel de l'app : http://leed.idleman.fr/ +* Dépôt de code officiel de l'app : http://git.idleman.fr/LeedRSS/Leed +* Documentation YunoHost pour cette app : https://yunohost.org/app_leed +* Signaler un bug : https://github.com/YunoHost-Apps/leed_ynh/issues -## Fonctionnalités spécifiques à YunoHost - -* Login sécurisé par Fail2Ban - -#### Support multi-utilisateurs - -Non supportée. - -#### Architectures supportées. - -* x86-64 - [![](https://ci-apps.yunohost.org/ci/logs/leed%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/leed/) -* ARMv8-A - [![](https://ci-apps-arm.yunohost.org/ci/logs/leed%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/leed/) - -## Informations additionnelles - -## Liens - - * Reporter un bug : https://github.com/YunoHost-Apps/leed_ynh/issues - * Site de Leed : http://leed.idleman.fr/ - * Dépôt de Leed : http://git.idleman.fr/LeedRSS/Leed - * Site de YunoHost : https://yunohost.org/ - ---- - -## Informations à l'intention des développeurs +## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/leed_ynh/tree/testing). -Pour tester la branche testing, merci de procéder ainsi. +Pour essayer la branche testing, procédez comme suit. ``` sudo yunohost app install https://github.com/YunoHost-Apps/leed_ynh/tree/testing --debug ou sudo yunohost app upgrade leed -u https://github.com/YunoHost-Apps/leed_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file