From bc9623dc8385e5fec36faef80ccfde0ad17fb25f Mon Sep 17 00:00:00 2001
From: ericgaspar <junk.eg@free.fr>
Date: Tue, 26 Jan 2021 09:04:21 +0100
Subject: [PATCH] Update README.md

---
 README.md | 79 +++++++++++++++++++++++++++++++++++--------------------
 1 file changed, 50 insertions(+), 29 deletions(-)

diff --git a/README.md b/README.md
index 7623870..dc3c5ad 100644
--- a/README.md
+++ b/README.md
@@ -1,42 +1,63 @@
-# ![ulogger_logo_small](https://cloud.githubusercontent.com/assets/3366666/24080878/0288f046-0ca8-11e7-9ffd-753e5c417756.png) μlogger
+# μlogger for YunoHost
 
-[![Integration level](https://dash.yunohost.org/integration/ulogger.svg)](https://dash.yunohost.org/appci/app/ulogger)  
-[![Install ulogger with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=ulogger)
+[![Integration level](https://dash.yunohost.org/integration/ulogger.svg)](https://dash.yunohost.org/appci/app/ulogger) ![](https://ci-apps.yunohost.org/ci/badges/ulogger.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/ulogger.maintain.svg)  
+[![Install μlogger with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ulogger)
 
-- [Yunohost project](https://yunohost.org)
-- [μlogger](https://github.com/bfabiszewski/ulogger-server)
+> *This package allows you to install μlogger 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.*
 
-## Description of the app.
-This is a web application for real-time collection of geolocation data, tracks viewing and management. Together with a dedicated [μlogger mobile client](https://github.com/bfabiszewski/ulogger-android) it may be used as a complete self hosted server–client solution for logging and monitoring users' geolocation.<br><br>
+## Overview
+This is a web application for real-time collection of geolocation data, tracks viewing and management. Together with a dedicated [μlogger mobile client](https://github.com/bfabiszewski/ulogger-android) it may be used as a complete self hosted server–client solution for logging and monitoring users' geolocation.
 
-<strong>Version:</strong> 0.5 <br><br>
+**Version:** 1.0
 
-## Live demo:
-- http://ulogger.fabiszewski.net/ (test track upload and editing, login: demo, password: demo)
+## Demo
+* [Official demo](http://ulogger.fabiszewski.net/) (login: demo, password: demo)
 
-## Features:
-- simple
-- allows live tracking
-- track statistics
-- altitudes graph
-- multiple users
-- user authentication
-- Google Maps API v3
-- OpenLayers v2 or v3 (OpenStreet and other layers)
-- ajax
-- user preferences stored in cookies
-- simple admin menu
-- export tracks to gpx and kml
-- import tracks from gpx
+## Configuration
 
-## To-Do's
-- [ ] Use config file from the sources rather then conf/config.php for the configuration.
+How to configure this app: From an admin panel, a plain file with SSH, or any other way.
 
-**Multi-user:** Yes
+## Documentation
+
+ * Official documentation: Link to the official documentation of this app
+ * YunoHost documentation: If specific documentation is needed, feel free to contribute.
+
+## YunoHost specific features
+
+#### Multi-user support
+
+* Are LDAP and HTTP auth supported? **No**
+* Can the app be used by multiple users? **Yes**
 
 #### Supported architectures
 
-* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/ulogger%20%28Community%29.svg)](https://ci-apps.yunohost.org/ci/apps/ulogger/)
+* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/ulogger%20%28Community%29.svg)](https://ci-apps.yunohost.org/ci/apps/ulogger/)
 * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/ulogger%20%28Community%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/ulogger/)
-* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/ulogger%20%28Community%29.svg)](https://ci-stretch.nohost.me/ci/apps/ulogger/)
 
+## Limitations
+
+* Any known limitations.
+
+## Additional information
+
+* Other info you would like to add about this app.
+
+## Links
+
+ * Report a bug: https://github.com/YunoHost-Apps/ulogger_ynh/issues
+ * Upstream app repository: https://github.com/bfabiszewski/ulogger-server
+ * YunoHost website: https://yunohost.org/
+
+---
+
+## Developer info
+
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/ulogger_ynh/tree/testing).
+
+To try the testing branch, please proceed like that.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/ulogger_ynh/tree/testing --debug
+or
+sudo yunohost app upgrade ulogger -u https://github.com/YunoHost-Apps/ulogger_ynh/tree/testing --debug
+```