docs: update readme (#3)

LizardByte · Dec 14, 2023 · 1764ec4 · 1764ec4
1 parent 3fd8bbb
commit 1764ec4
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 6 deletions.
diff --git a/.gitignore b/.gitignore
@@ -158,9 +158,3 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 .idea/
-
-# repo specific ignores
-*.json
-*.png
-*.tmp
-*.zip
diff --git a/README.md b/README.md
@@ -2,3 +2,31 @@
 
 This repository hosts LizardByte's Jellyfin plugins in gh-pages. Additionally, there is a re-usable GitHub action
 that can be used to publish your own plugins to your own gh-pages repository. See [action.yml](action.yml) for details.
+
+## Install LizardByte Jellyfin repository
+
+1. Open the Jellyfin dashboard
+2. Navigate to the `Plugins` menu
+3. Click the `Repositories` tab
+4. Click the `+` button
+5. Enter one of the following URLs:
+
+    *Primary*
+    ```txt
+    https://app.lizardbyte.dev/jellyfin-plugin-repo/manifest.json
+    ```
+
+    *Alternate*
+    ```txt
+    https://lizardbyte.github.io/jellyfin-plugin-repo/manifest.json
+    ```
+
+    *It should look like this:*
+    ![Add Repository](/docs/images/jellyfin_new_repository.png)
+
+6. Click `Save`
+7. Confirm the warning
+
+    ![Confirm Warning](/docs/images/jellyfin_confirm_third_party_plugin.png)
+
+8. Select the `Catalog` tab to see the newly added plugins.
diff --git a/docs/images/jellyfin_confirm_third_party_plugin.png b/docs/images/jellyfin_confirm_third_party_plugin.png
diff --git a/docs/images/jellyfin_new_repository.png b/docs/images/jellyfin_new_repository.png