docs(header): add readme

Signed-off-by: Kai Henseler <[email protected]>

IONOS/README.md

@@ -1,18 +1,63 @@
-Themes can be used to customize the look and feel without the need to patch the source code. This makes it very easy to:
+# ✨ IONOS Global Navigation ✨
 
-* Use your own logo (in the top left, in log in and in emails)
-* Customize the text strings to replace »Nextcloud« etc. with your name of choice
-* Change the main color (used in header and as log in background)
-* And more …
+as a Custom Element written in Svelte for convenience. Targeted to be used as Header for Easystorage as part of a custom Nextcloud theme (`/themes`).
 
+## Usage
 
-The process is simple:
+### Activate Theme
+1. put the a folder with the name of the theme as foldername into `/themes`
+2. activate by putting `'theme' => 'nc-ionos-theme',` into the `config.php`
+3. (optional) make theme exclusive by putting `'theme => 'nc-ionos-theme'` into the `config.php` file
 
-1. Put a folder here with the name of the theme as foldername (`nc-ionos-theme`)
-2. Activate it by putting `'theme' => 'nc-ionos-theme',` into the config.php file
-3. (optional) make the theme exclusive by putting `'enforce-theme' => 'nc-ionos-theme',` into the config.php file
+### Use
+1. Import file
+for example using: `<script src="myscripts.js"></script>`
+2.  Insert Element
+```html
+<ionos-global-nav home_src="index.html">
+	<p>This is Placed on the rigth side of the header as a slot</p>
+</ionos-global-nav>
+```
+## ⚙️ Development
 
+### 🛠️ Setup
 
-The folder structure of a theme is exactly the same as the main structure. CSS files are loaded additionally to the default files so you can override properties. Images are replaced. You can also override JS files and PHP templates but we do not recommend that because you will need to adjust them after every update.
+#### 📦 Podman Dev Container
 
-You can also find a basic example here which you can build upon.
+Uses containerized Node environment
+
+simply run `make run-dev` to start a container, install dependencies and start the dev server.
+
+#### 🖥️ Without Container
+
+Make sure Node v20 is installed
+
+1. run `npm install` to install dependencies
+2. run `npm run dev` to start dev server
+
+### 🚀 Build
+#### 💻 local
+
+##### 📦 Container
+
+```shell
+make run-build
+```
+
+##### 🖥️ or without Container
+
+```shell
+npm run build
+```
+
+### 📏 Conventions
+
+The repository uses [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages.
+
+Example:
+
+`<type>[(optional scope)]: <description>`
+
+```shell
+git commit -sm "ci(release): add auto SemVer step"
+```