Merge branch 'patch2' of https://github.com/YunoHost-Apps/freshrss_ynh into patch2

README.md

@@ -1,24 +1,31 @@
+<!--
+N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
+It shall NOT be edited by hand.
+-->
+
 # FreshRSS for YunoHost
 
 [![Integration level](https://dash.yunohost.org/integration/freshrss.svg)](https://dash.yunohost.org/appci/app/freshrss) ![](https://ci-apps.yunohost.org/ci/badges/freshrss.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/freshrss.maintain.svg)  
 [![Install FreshRSS with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=freshrss)
 
-> *This package allow you to install FreshRSS quickly and simply on a YunoHost server.
+*[Lire ce readme en français.](./README_fr.md)*
-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 FreshRSS 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
 
-An efficient but powerful RSS aggregator with a nice and mobile-friendly design, as well as extension and themes support.
+RSS aggregator with a nice and mobile-friendly design
 
-**Shipped version:** 1.18.0
+**Shipped version:** 1.18.1~ynh1
+
+**Demo:** https://demo.freshrss.org
 
 ## Screenshots
 
-![](https://freshrss.org/images/screenshot.png)
+![](./doc/screenshots/screenshot.png)
 
-## Demo
+## Disclaimers / important information
-
-* [Official demo](https://demo.freshrss.org)
 
 ## Configuration
 
@@ -28,32 +35,24 @@ API (mini) How To:
 * Check that the API is working: https://example.net/rss/api/greader.php
 * Setup your client with: username: ynh user, password: the password you just setup, URL https://example.tld/rss/api/greader.php
 
+## Documentation and resources
 
-## Documentation
+* Official app website: http://freshrss.org/
+* Official user documentation: https://yunohost.org/apps
+* Official admin documentation: https://freshrss.github.io/FreshRSS/
+* Upstream app code repository: https://github.com/FreshRSS/FreshRSS
+* YunoHost documentation for this app: https://yunohost.org/app_freshrss
+* Report a bug: https://github.com/YunoHost-Apps/freshrss_ynh/issues
 
- * Official documentation: https://freshrss.github.io/FreshRSS/
+## Developer info
 
-#### Supported architectures
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/freshrss_ynh/tree/testing).
 
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/freshrss%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/freshrss/)
+To try the testing branch, please proceed like that.
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/freshrss%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/freshrss/)
-
-## Links
-
- * Report a bug: https://github.com/YunoHost-Apps/freshrss_ynh/issues
- * App website: https://freshrss.org/
- * Upstream app repository: https://github.com/FreshRSS/FreshRSS
- * YunoHost website: https://yunohost.org/
-
----
-
-## Developers info
-
-Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/freshrss_ynh/tree/testing).
-
-To try the testing branch, please proceed like this:
 ```
 sudo yunohost app install https://github.com/YunoHost-Apps/freshrss_ynh/tree/testing --debug
 or
 sudo yunohost app upgrade freshrss -u https://github.com/YunoHost-Apps/freshrss_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps

README_fr.md

@@ -0,0 +1,54 @@
+# FreshRSS pour YunoHost
+
+[![Niveau d'intégration](https://dash.yunohost.org/integration/freshrss.svg)](https://dash.yunohost.org/appci/app/freshrss) ![](https://ci-apps.yunohost.org/ci/badges/freshrss.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/freshrss.maintain.svg)  
+[![Installer FreshRSS avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=freshrss)
+
+*[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *Ce package vous permet d'installer FreshRSS 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
+
+Agrégateur de flux RSS avec une interface adaptée au mobile
+
+**Version incluse :** 1.18.1~ynh1
+
+**Démo :** https://demo.freshrss.org
+
+## Captures d'écran
+
+![](./doc/screenshots/screenshot.png)
+
+## Avertissements / informations importantes
+
+## Configuration
+
+API (mini) How To:
+* Into your user profile: Settings > profil
+* Setup an API password
+* Check that the API is working: https://example.net/rss/api/greader.php
+* Setup your client with: username: ynh user, password: the password you just setup, URL https://example.tld/rss/api/greader.php
+
+## Documentations et ressources
+
+* Site officiel de l'app : http://freshrss.org/
+* Documentation officielle utilisateur : https://yunohost.org/apps
+* Documentation officielle de l'admin : https://freshrss.github.io/FreshRSS/
+* Dépôt de code officiel de l'app : https://github.com/FreshRSS/FreshRSS
+* Documentation YunoHost pour cette app : https://yunohost.org/app_freshrss
+* Signaler un bug : https://github.com/YunoHost-Apps/freshrss_ynh/issues
+
+## Informations pour les développeurs
+
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/freshrss_ynh/tree/testing).
+
+Pour essayer la branche testing, procédez comme suit.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/freshrss_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade freshrss -u https://github.com/YunoHost-Apps/freshrss_ynh/tree/testing --debug
+```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps