From 16e16a0ac29dd6c58ab1746fe4210a303931fc99 Mon Sep 17 00:00:00 2001
From: Luke Murphy <lukewm@riseup.net>
Date: Sat, 20 Jul 2019 20:33:05 +0200
Subject: [PATCH] Use an `example_ynh` README

---
 README.md | 84 ++++++++++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 77 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index daa3056..a74a09b 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,80 @@
-ethercalc_ynh
-===============
-[![Install Ethercalc with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=ethercalc)
+# EtherCalc for YunoHost
 
-ETAT = INPROGRESS
-EtherCalc for YunoHost
+[![Integration level](https://dash.yunohost.org/integration/ethercalc_.svg)](https://dash.yunohost.org/appci/app/ethercalc)
+[![Install EtherCalc with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=ethercalc)
 
-EtherCalc is an online web spreadsheet.
+> *This package allow you to install EtherCalc quickly and simply on a YunoHost server.
 
-https://ethercalc.net/
+If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
+
+## Status
+
+Work. In. Progress.
+
+## Overview
+
+EtherCalc is a web spreadsheet.
+
+Your data is saved on the web, and people can edit the same document at the same time. Everybody's changes are instantly reflected on all screens. Work together on inventories, survey forms, list management, brainstorming sessions and more!
+
+**Shipped version:** [0.20170704.0](https://github.com/audreyt/ethercalc/tree/0.20170704.0)
+
+## Screenshots
+
+![](https://ethercalc.org/static/img/davy/gfx/screenshot.png)
+
+## Demo
+
+* [Official demo](https://ethercalc.org/_new)
+
+## Configuration
+
+N/A.
+
+## Documentation
+
+ * [Official EtherCalc documentation](https://ethercalc.net/#ch1)
+
+## YunoHost specific features
+
+#### Multi-users support
+
+* TODO
+
+#### Supported architectures
+
+* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/ethercalc%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/ethercalc/)
+* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/ethercalc%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/ethercalc/)
+* Stretch x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/ethercalc%20%28Apps%29.svg)](https://ci-stretch.nohost.me/ci/apps/ethercalc/)
+
+## Limitations
+
+* TODO
+
+## Additional information
+
+N/A.
+
+## Links
+
+ * Report a bug: https://github.com/YunoHost-Apps/ethercalc_ynh/issues
+ * App website: https://ethercalc.net/
+ * Upstream app repository: https://github.com/audreyt/ethercalc
+ * 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/ethercalc_ynh/tree/testing).
+
+To try the testing branch, please proceed like that.
+
+```
+$ sudo yunohost app install https://github.com/YunoHost-Apps/ethercalc_ynh/tree/testing --debug
+$ # or ...
+$ sudo yunohost app upgrade ethercalc -u https://github.com/YunoHost-Apps/ethercalc_ynh/tree/testing --debug
+```