From 6d5c0b86b25c7019f13ccde7fc943711ec9f9959 Mon Sep 17 00:00:00 2001
From: DarkFighterLuke <31162436+DarkFighterLuke@users.noreply.github.com>
Date: Wed, 17 Apr 2024 22:48:55 +0200
Subject: [PATCH] Update README.md
Update references to point to the new repository
---
README.md | 29 ++++++++++++++++-------------
1 file changed, 16 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
index dd49369..f69f870 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
Jellyfin TubeArchivist Plugin
-
+
@@ -27,17 +27,18 @@ The plugin interacts with TubeArchivist APIs to fetch videos and channels metada
1. Go to `Dashboard -> Plugins` and select the `Repositories` tab
2. Add a new repository with the following details:
- Repository name: `TubeArchivistMetadata`
-- Repository URL: `https://github.com/DarkFighterLuke/TubeArchivistMetadata/raw/master/manifest.json`
- 
+- Repository URL: `https://github.com/tubearchivist/tubearchivist-jf-plugin/raw/master/manifest.json`
+ 
+
3. Go to the `Catalog` tab
4. Find `TubeArchivistMetadata` in the `Metadata` section and install it
-
+
5. Restart Jellyfin to apply the changes
-
+
### From ZIP in GitHub releases
-1. Download the latest available release (`TubeArchivist-*.zip`) from the repository releases section
+1. Download the latest available release (`TubeArchivistMetadata-*.zip`) from the repository releases section
2. Extract the contained files in the `plugins/TubeArchivistMetadata` folder (you might need to create the folders) of your Jellyfin installation
-3. Restart Jellyfin to apply the changes
+3. Restart Jellyfin to apply the changes
## Configuration
This plugin requires that you have already an instance of TubeArchivist up and running.
@@ -49,7 +50,8 @@ Once installed, you have to configure the following parameters in the plugin con
Overviews length (channels and videos descriptions)
-
+
+
## Use the plugin
Using the plugin is very simple. Let's start from the beginning:
@@ -57,9 +59,10 @@ Once installed, you have to configure the following parameters in the plugin con
_NOTE: If you are using Docker containers, it is important to mount the TubeArchivist media path into Jellyfin container as **read-only**, in order to avoid possible operations on the media files that will break TubeArchivist._
1. Go to `Dashboard -> Libraries` and add a media library
2. In the form select `Shows` as Content type, set a display name for the library and set the TubeArchivist media folder in the `Folders` section
-
-3. Scrolling down, uncheck all metadata and image providers except `TubeArchivist`. (You won't find TubeArchivist in seasons providers, so just disable everything there)
-4. Save and come back to Home, you will see the newly added library. Jellyfin will have executed the metadata fetching for you after the collection creation and then you will see the metadata and the images of channels and videos
+
+
+4. Scrolling down, uncheck all metadata and image providers except `TubeArchivist`. (You won't find TubeArchivist in seasons providers, so just disable everything there)
+5. Save and come back to Home, you will see the newly added library. Jellyfin will have executed the metadata fetching for you after the collection creation and then you will see the metadata and the images of channels and videos
## Build
@@ -67,10 +70,10 @@ _NOTE: If you are using Docker containers, it is important to mount the TubeArch
2. Build plugin with following command
```
- dotnet publish Jellyfin.Plugin.TubeArchivistMetadata --configuration Release --output bin
+ dotnet publish Jellyfin.Plugin.tubearchivist-jf-plugin --configuration Release --output bin
```
-3. Place the dll-file in the `plugins/TubeArchivistMetadata` folder (you might need to create the folders) of your Jellyfin installation
+3. Place the dll-file in the `plugins/tubearchivist-jf-plugin` folder (you might need to create the folders) of your Jellyfin installation
## License