Update README.md

README.md

@@ -4,3 +4,81 @@
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/c867f25820614ed795e7567e37bd81c0)](https://www.codacy.com/app/keshrath/muk_base?utm_source=github.com&utm_medium=referral&utm_content=muk-it/muk_base&utm_campaign=Badge_Grade)
 
 # MuK Odoo Base Modules
+
+This set of modules offers mainly utility functions and libraries that are intended to be used in other projects.
+
+### 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.
+
+The biggest advantage of this variant is that you can now also update
+the app using the "pip" command. To do this, enter the following command
+in your 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. The steps are the same as for the installation only
+the button has changed from "Install" to "Upgrade".
+
+You can also view available Apps directly in our [repository] and find a
+more detailed installation guide on our [website].
+
+For modules licensed under OPL-1, you will receive access data when you
+purchase the module. If the modules were not purchased directly from
+[MuK IT] please contact our support (<support@mukit.at>) with a
+confirmation of purchase to receive the corresponding access data.
+
+### 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/