Update README.md

README.md

@@ -1,36 +1,42 @@
-[![Install Weblate with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=weblate)
+# Weblate for YunoHost
-![](https://dash.yunohost.org/integration/weblate.svg)
-# Weblate translation platform for YunoHost
 
-The YunoHost team uses [Weblate](https://weblate.org) for translations: https://translate.yunohost.org
+[![Integration level](https://dash.yunohost.org/integration/weblate.svg)](https://dash.yunohost.org/appci/app/weblate) ![](https://ci-apps.yunohost.org/ci/badges/weblate.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/weblate.maintain.svg)  
+[![Install Weblate with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=weblate)
+
+> *This package allows you to install Weblate 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
+
+Weblate is a libre web-based translation tool with tight version control integration. It provides two user interfaces, propagation of translations across components, quality checks and automatic linking to source files.
+
+**Shipped version:** 3.8.0
+
+## Screenshots
+
+![](https://weblate.org/static/img/BigScreenshot.png)
+
+## Demo
+
+* [YunoHost project uses Weblate for translations](https://translate.yunohost.org)
 
 ## Admin account
 
 An admin user is created at installation, the login is what you provided at installation, the password is **weblate**.
 
-## Weblate 3.0 upgrade
-
-This upgrade is a major one, remember to read this page before upgrading: https://docs.weblate.org/en/latest/admin/upgrade.html#upgrade-3
-
-After upgrading:
-
- * All existing users and groups have been migrated to new model.
- * Any per user permissions are removed, please assign users to appropriate groups and roles to grant them permissions.
- * Any custom groups will not have any permissions after upgrade, please grant the permissions again.
-
 ## Github
 
-You'll need to give weblate a github user and a token. Please read [github's documentation about token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/).
+You'll need to give Weblate a Github user and a token. Please read [Github's documentation about token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/).
 This user will only be used to open the pull-request, each translation keep his author.
 
-**Careful**, I still have to understand why, but you'll have to **manually** move your hub binary frile from /var/www/$app/bin/ to /usr/bin to enable pull request on github. I'm close to fix this.
+**Careful**, You will have to **manually** move your hub binary file from `/var/www/$app/bin/` to `/usr/bin` to enable pull request on Github.
 
-**SSH keys**, you'll have to go in administration, and generate a public key for weblate and add github.com so weblate knows the fingerprint. Please note if your account already have a public key (ssh-rsa), you'll have to manually add the weblate's one to your github account.
+**SSH keys**, you will have to go in administration, and generate a public key for weblate and add github.com so Weblate knows the fingerprint. Please note if your account already have a public key (ssh-rsa), you will have to manually add the Weblate's one to your Github account.
 
 ## Settings and upgrades
 
 Almost everything related to Weblate's configuration is handled in a `settings.py` file.
-You'll probably edit it to enable or disable diverse features, it is stored in `$final_path/venv/lib/python2.7/site-packages/weblate/settings.py`.
+You will probably edit it to enable or disable diverse features, it is stored in `$final_path/venv/lib/python2.7/site-packages/weblate/settings.py`.
 
 Unfortunatly, this settings file also gets upgrades for each release.
 
@@ -54,23 +60,18 @@ Carefull, this application install PostgreSQL and change the default configurati
 
 It doesn't work yet, but while [it looks doable](https://docs.weblate.org/en/latest/admin/auth.html?highlight=LDAP#ldap-authentication), I'm unsure it is a good idea to connect this kind of tools to your LDAP.
 
-## State of this package
+#### Supported architectures
 
-* works fine:
+* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/weblate%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/weblate/)
-[x] install/remove/backup/remove/upgrade with x86_64
+* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/weblate%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/weblate/)
 
-* to be confirmed:
+## Limitations
-[ ] ARM support
 
-* to be added:
+* Any known limitations.
-[ ] use jq instead of grep/sed
+
-[ ] change URL script
+## Additional information
-[ ] use debian package for lxml (may unlock ARM support)
+
-[ ] Add configuration options using the YunoHost interface (https://forum.yunohost.org/t/yunohost-3-1-minor-stable-release-version-stable-mineure/5445)
+* Other info you would like to add about this app.
-[ ] Add fail2ban script
-[ ] Enable CHECK_LIST?
-[ ] Enable AUTOFIX_LIST?
-[ ] Enable Translation Memory?
 
 ## Links
 
@@ -79,3 +80,17 @@ It doesn't work yet, but while [it looks doable](https://docs.weblate.org/en/lat
  * Documentation: https://docs.weblate.org/
  * Weblate website: https://weblate.org/
  * YunoHost website: https://yunohost.org/
+
+---
+
+Developer info
+----------------
+
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/weblate_ynh/tree/testing).
+
+To try the testing branch, please proceed like that.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/weblate_ynh/tree/testing --debug
+or
+sudo yunohost app upgrade weblate -u https://github.com/YunoHost-Apps/weblate_ynh/tree/testing --debug
+```