docs: add README steps

midarrlabs · Sep 5, 2023 · 81a5f86 · 81a5f86
1 parent 8ec9894
commit 81a5f86
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,25 @@
-# Midarr for Kodi
+## Midarr for Kodi repository
+
+Contains simple Midarr for Kodi add-on.
+
+### Installation
+
+1. Add repository:
+
+```bash
+https://midarrlabs.github.io/repository.midarr/
+```
+
+2. Install Midarr:
+
+![Preview](docs/step-1-repository.png)
+![Preview](docs/step-2-video.png)
+![Preview](docs/step-3-midarr.png)
+![Preview](docs/step-4-install.png)
+
+3. Configure settings:
+
+Enter your server url and API token
+
+![Preview](docs/step-5-configure.png)
+![Preview](docs/step-6-settings.png)
diff --git a/docs/step-1-repository.png b/docs/step-1-repository.png
diff --git a/docs/step-2-video.png b/docs/step-2-video.png
diff --git a/docs/step-3-midarr.png b/docs/step-3-midarr.png
diff --git a/docs/step-4-install.png b/docs/step-4-install.png
diff --git a/docs/step-5-configure.png b/docs/step-5-configure.png
diff --git a/docs/step-6-settings.png b/docs/step-6-settings.png