Updated readme

README.md

@@ -1,82 +1,39 @@
-# Usage of this package (REMOVE THIS SECTION BEFORE RELEASE)
+# Matomo app for Yunohost
-- Copy this app before working on it.
-- Edit `conf/nginx.conf` file to match application prerequisites.
-- Edit `manifest.json` with application specific information.
-- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts.
-- Add a `LICENSE` file for the package.
-- Edit `README.md`.
 
-# Example app for YunoHost
 
-[![Integration level](https://dash.yunohost.org/integration/REPLACEBYYOURAPP.svg)](https://ci-apps.yunohost.org/jenkins/job/REPLACEBYYOURAPP%20%28Community%29/lastBuild/consoleFull)  
+[![Integration level](https://dash.yunohost.org/integration/matomo.svg)](https://ci-apps.yunohost.org/jenkins/job/matomo%20%28Community%29/lastBuild/consoleFull)  
-[![Install REPLACEBYYOURAPP with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP)
+[![Install matomo with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=matomo)
 
-> *This package allow you to install REPLACEBYYOURAPP quickly and simply on a YunoHost server.  
+> *This package allow you to install Matomo quickly and simply on a YunoHost server.  
 If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
 
-## Overview
+## Matomo
-Quick description of this app.
+Matomo is the only analytics platform that gives you full control over your data and more:
 
-**Shipped version:** 1.0
+- Free open-source software
+- 100% data ownership
+- User privacy protection
+- User-centric insights
+- Customisable and extensible
+- Easy to use
+- No data limits
 
-## Screenshots
+## Important links
-
+- [Yunohost project](https://yunohost.org)
-![](Link to an screenshot for this app)
+- [Matomo](https://matomo.org/)
-
-## Demo
-
-* [Official demo](Link to a demo site for this app)
 
 ## Configuration
+1. The app will require to complete the registration process after the instllation is complete by **visiting the domain** on  which Matomo is installed.
+1. The mysql database credentials will be sent to the **admin mail**. Fill these details while doing the registration process.
+1. No Ldap support yet for the app.
+<br><br>
 
-How to configure this app: by an admin panel, a plain file with SSH, or any other way.
 
-## Documentation
+The app is **Multi-instance**.
 
- * 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-users support
 
-Are LDAP and HTTP auth supported?
-Can the app be used by multiple users?
 
-#### Supported architectures
 
-* x86-64b - [![Build Status](https://ci-apps.yunohost.org/jenkins/job/REPLACEBYYOURAPP%20(Community)/badge/icon)](https://ci-apps.yunohost.org/jenkins/job/REPLACEBYYOURAPP%20(Community)/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/jenkins/job/REPLACEBYYOURAPP%20(Community)%20(%7EARM%7E)/badge/icon)](https://ci-apps-arm.yunohost.org/jenkins/job/REPLACEBYYOURAPP%20(Community)%20(%7EARM%7E)/)
-* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/jenkins/job/REPLACEBYYOURAPP%20(Community)/badge/icon)](https://ci-stretch.nohost.me/jenkins/job/REPLACEBYYOURAPP%20(Community)/)
-
-## Limitations
-
-* Any known limitations.
-
-## Additional information
-
-* Other information you would add about this application
-
-**More information on the documentation page:**  
-https://yunohost.org/packaging_apps
-
-## Links
-
- * Report a bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues
- * App website: Link to the official website of this app
- * YunoHost website: https://yunohost.org/
-
----
-
-Developers info
-----------------
-
-**Only if you want to use a testing branch for coding, instead of merging directly into master.**
-Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing).
-
-To try the testing branch, please proceed like that.
-```
-sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
-or
-sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
 ```