Merge branch 'patch' of https://github.com/YunoHost-Apps/firefly-iii into patch

README.md

@@ -1,55 +1,37 @@
+<!--
+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.
+-->
+
 # Firefly III for YunoHost
 
 [![Integration level](https://dash.yunohost.org/integration/firefly-iii.svg)](https://dash.yunohost.org/appci/app/firefly-iii) ![](https://ci-apps.yunohost.org/ci/badges/firefly-iii.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/firefly-iii.maintain.svg)  
-[![Install Firefly III with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=firefly-iii)
+[![Install Firefly III with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=firefly-iii)
+
+*[Lire ce readme en français.](./README_fr.md)*
 
 > *This package allows you to install Firefly III 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
-"Firefly III" is a (self-hosted) manager for your personal finances. It can help you keep track of your expenses and income, so you can spend less and save more. Firefly III supports the use of budgets, categories and tags. It can import data from external sources and it has many neat financial reports available. You can [read all about it in the main repository](https://github.com/firefly-iii/firefly-iii) and in the [official documentation](https://docs.firefly-iii.org/).
 
-**Shipped version:** 5.5.11
+Self-hosted financial manager.
+
+**Shipped version:** 5.5.11~ynh2
+
+**Demo:** https://demo.firefly-iii.org/login
 
 ## Screenshots
 
-![](index.png)
+![](./doc/screenshots/budget.png)
 
-## Demo
+## Documentation and resources
 
-* [Demo 1](https://demo.firefly-iii.org/login)
+* Official app website: https://firefly-iii.org/
-* [Demo 2](http://www.softaculous.com/softaculous/demos/Firefly_III)
+* Official admin documentation: https://docs.firefly-iii.org/
-
+* Upstream app code repository: https://github.com/firefly-iii/firefly-iii
-## Documentation
+* YunoHost documentation for this app: https://yunohost.org/app_firefly-iii
-
+* Report a bug: https://github.com/YunoHost-Apps/firefly-iii_ynh/issues
- * Official documentation: https://docs.firefly-iii.org/
-
-## YunoHost specific features
-
-#### Multi-user support
-
-- The admin user should be the first user to log into Firefly III
-- SSO is not working yet
-- You will probably be warned about missing locale from your system. Once you change the language to those corresponding to your system, the warning will desapear
-
-#### Supported architectures
-
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/firefly-iii%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/firefly-iii/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/firefly-iii%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/firefly-iii/)
-
-## Links
-
- * Report a bug: https://github.com/YunoHost-Apps/firefly-iii_ynh/issues
- * App website: https://firefly-iii.org/
- * Upstream app repository: https://github.com/firefly-iii/firefly-iii
- * YunoHost website: https://yunohost.org/
-
-TODO
- - [ ] Make Firefly III admin user dependant of the user choosen at installation
- - [ ] Make SSO work
- - [ ] Define default language according to system language
-
----
 
 ## Developer info
 
@@ -61,3 +43,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/firefly-iii_ynh/tree/
 or
 sudo yunohost app upgrade firefly-iii -u https://github.com/YunoHost-Apps/firefly-iii_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps

README_fr.md

@@ -0,0 +1,43 @@
+# Firefly III pour YunoHost
+
+[![Niveau d'intégration](https://dash.yunohost.org/integration/firefly-iii.svg)](https://dash.yunohost.org/appci/app/firefly-iii) ![](https://ci-apps.yunohost.org/ci/badges/firefly-iii.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/firefly-iii.maintain.svg)  
+[![Installer Firefly III avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=firefly-iii)
+
+*[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *Ce package vous permet d'installer Firefly III 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
+
+Gestionnaire de finances personnelles.
+
+**Version incluse :** 5.5.11~ynh2
+
+**Démo :** https://demo.firefly-iii.org/login
+
+## Captures d'écran
+
+![](./doc/screenshots/budget.png)
+
+## Documentations et ressources
+
+* Site officiel de l'app : https://firefly-iii.org/
+* Documentation officielle de l'admin : https://docs.firefly-iii.org/
+* Dépôt de code officiel de l'app : https://github.com/firefly-iii/firefly-iii
+* Documentation YunoHost pour cette app : https://yunohost.org/app_firefly-iii
+* Signaler un bug : https://github.com/YunoHost-Apps/firefly-iii_ynh/issues
+
+## Informations pour les développeurs
+
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/firefly-iii_ynh/tree/testing).
+
+Pour essayer la branche testing, procédez comme suit.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/firefly-iii_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade firefly-iii -u https://github.com/YunoHost-Apps/firefly-iii_ynh/tree/testing --debug
+```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps