From 6de6049326009c9ae42db3ae16227e766334424f Mon Sep 17 00:00:00 2001
From: aymhce <aymhce@gmail.com>
Date: Sat, 27 Jan 2018 22:14:56 +0100
Subject: [PATCH] update readme for YunoHost/apps#410

---
 README.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 58 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index ad1a18f..21fa330 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,59 @@
-# Ampache package for YunoHost
+Ampache for YunoHost
+---------------------
 
-* [Ampache website](http://ampache.org/)
-* [YunoHost website](https://yunohost.org)
+[Ampache](http://ampache.org) for the love of music. A web based audio/video 
+streaming application and file manager allowing you to access your 
+music & videos from anywhere, using almost any internet enabled device.
+
+**Shipped version:** 3.8.3
+
+[![Install Ampache with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=ampache)
+![](http://ampache.org/img/previews/visualizer.jpg)
+
+## Features
+
+In addition to Ampache core features, the following are made available with
+this package:
+
+ * Config for high quality streaming with high bandwith
+ * Quick loading for mobile devices with potential low bandwith
+ * Integrate with YunoHost users - same username and password
+ * Allow one user to be the administrator (set at the installation)
+
+## Getting start
+
+ * **Add your first catalog to load music files**
+   * Go to *Admin panel* [](https://raw.githubusercontent.com/ampache/ampache/develop/themes/reborn/images/icons/icon_admin.png)
+   * Click on *Add a Catalog*
+   * Fill up fields and click *Add Calalog*
+   * Next, enjoy :)
+
+ * **Update a catalog for load new music files**
+   * Go to *Admin panel* [](https://raw.githubusercontent.com/ampache/ampache/develop/themes/reborn/images/icons/icon_admin.png)
+   * Click on *Show Catalogs*
+   * Select *Update* in *Actions* list and click *Go*
+
+ * **Change interface Language**
+   * Go to *Preferences panel* [](https://raw.githubusercontent.com/ampache/ampache/develop/themes/reborn/images/icons/icon_edit.png)
+   * Click on *Interface*
+   * Change *Language* field
+
+## Ampache on mobile devices
+
+ * [For Android](https://play.google.com/store/apps/details?id=com.antoniotari.reactiveampacheapp)
+ * [For iOS](http://iampache.com/)
+
+ * Full list of existings clients : https://github.com/ampache/ampache/wiki/Clients
+
+## Limitations
+
+The user panel button was disabled because it hide an essential part of the ampache user interface.
+
+Also, the SSO authentication not fully working from user panel, we have to work about this.
+In fact, it's can disrupt external Ampache clients like Subsonic.
+
+## Links
+
+ * Report a bug: https://github.com/YunoHost-Apps/ampache_ynh/issues
+ * Ampache website: http://ampache.org/
+ * YunoHost website: https://yunohost.org/