From a1896a4f99ed8e7798ed54242836a881d4c9b48e Mon Sep 17 00:00:00 2001
From: Mathias Markl <mathias.markl@mukit.at>
Date: Mon, 30 Jul 2018 18:04:27 +0200
Subject: [PATCH] Update README.md

---
 README.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 61 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 6091005..4d96055 100644
--- a/README.md
+++ b/README.md
@@ -5,11 +5,65 @@
 
 # MuK Odoo Web Modules
 
-addon | version | summary
---- | --- | ---
-[muk_web_client](muk_web_client/) | 11.0 | Odoo Web Client Extension
-[muk_web_client_refresh](muk_web_client_refresh/) | 11.0 | Web Client Refresh
-[muk_web_preview](muk_web_preview/) | 11.0 | Preview Dialog
-[muk_web_preview_attachment](muk_web_preview_attachment/) | 11.0 | Preview Dialog Attachment
-[muk_web_share](muk_web_share/) | 11.0 | Share Dialog
+This set of modules offers improvments and extensions to the Odoo web client.
 
+### Installation
+
+To install this module, you need to:
+
+Download the module and add it to your Odoo addons folder. Afterward,
+log on to your Odoo server and go to the Apps menu. Trigger the debug
+mode and update the list by clicking on the "Update Apps List" link. Now
+install the module by clicking on the install button.
+
+Another way to install this module is via the package management for
+Python ([PyPI]).
+
+To install our modules using the package manager make sure
+[odoo-autodiscover] is installed correctly. Then open a console and
+install the module by entering the following command:
+
+`pip install --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>`
+
+The module name consists of the Odoo version and the module name, where
+underscores are replaced by a dash.
+
+**Module:**
+
+`odoo<version>-addon-<module_name>`
+
+**Example:**
+
+`sudo -H pip3 install --extra-index-url https://nexus.mukit.at/repository/odoo/simple odoo11-addon-muk-utils`
+
+Once the installation has been successfully completed, the app is
+already in the correct folder. Log on to your Odoo server and go to the
+Apps menu. Trigger the debug mode and update the list by clicking on the
+"Update Apps List" link. Now install the module by clicking on the
+install button.
+
+You can also view available Apps directly in our [repository] and find a
+more detailed installation guide on our [website].
+
+### Upgrade
+
+To upgrade this module, you need to:
+
+Download the module and add it to your Odoo addons folder. Restart the
+server and log on to your Odoo server. Select the Apps menu and upgrade
+the module by clicking on the upgrade button.
+
+If you installed the module using the "pip" command, you can also update
+the module in the same way. Just type the following command into the
+console:
+
+`pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>`
+
+When the process is finished, restart your server and update the
+application in Odoo, just like you would normally.
+
+  [PyPI]: https://pypi.org/project/pip/
+  [odoo-autodiscover]: https://pypi.org/project/odoo-autodiscover/
+  [repository]: https://nexus.mukit.at/#browse/browse:odoo
+  [website]: https://mukit.at/page/open-source
+  [MuK IT]: https://www.mukit.at/