From 4ce8fb11e226eb9e2c744820fca27cdd00f57027 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89ric=20Gaspar?=
 <46165813+ericgaspar@users.noreply.github.com>
Date: Sun, 1 Nov 2020 15:48:56 +0100
Subject: [PATCH] Update README.md

---
 README.md | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 61 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 865655b..9852040 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,66 @@
-# BoZoN package for YunoHost
-Minimalist Drag & drop file sharing app
+# BoZoN for YunoHost
 
+[![Integration level](https://dash.yunohost.org/integration/bozon.svg)](https://dash.yunohost.org/appci/app/bozon) ![](https://ci-apps.yunohost.org/ci/badges/bozon.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/bozon.maintain.svg)  
 [![Install BoZoN with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=bozon)
 
-[![Integration level](https://dash.yunohost.org/integration/bozon.svg)](https://ci-apps.yunohost.org/jenkins/job/bozon%20%28Community%29/lastBuild/consoleFull) 
+> *This package allows you to install BoZoN 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
+BoZoN is a minimalist Drag & drop file sharing app.
+
+**Shipped version:** 2.4.18
+
+## Screenshots
+
+![](Link to a screenshot of this app.)
+
+## Configuration
+
+How to configure this app: From an admin panel, a plain file with SSH, or any other way.
+
+## 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?
+* Can the app be used by multiple users?
+
+#### Supported architectures
+
+* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/bozon%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/bozon/)
+* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/bozon%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/bozon/)
+
+## Limitations
+
+* Any known limitations.
+
+## Additional information
+
+* Other info you would like to add about this app.
 
 ## Links
-* [BoZoN website](http://bozon.pw)
-* [BoZoN git repository](https://github.com/broncowdd/BoZoN)
-* [YunoHost website](https://yunohost.org/)
+
+ * Report a bug: https://github.com/YunoHost-Apps/bozon_ynh/issues
+ * App website: http://bozon.pw
+ * Upstream app repository: https://github.com/broncowdd/BoZoN
+ * YunoHost website: https://yunohost.org/
+
+---
+
+## Developer info
+
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/bozon_ynh/tree/testing).
+
+To try the testing branch, please proceed like that.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/bozon_ynh/tree/testing --debug
+or
+sudo yunohost app upgrade bozon -u https://github.com/YunoHost-Apps/bozon_ynh/tree/testing --debug
+```
+