fix: Update README for clarity and correct repository links
This commit is contained in:
22
README.md
22
README.md
@@ -2,7 +2,9 @@
|
|||||||
|
|
||||||
Jellyfin Seasonals is a plugin that adds seasonal themes to your Jellyfin web interface. Depending on the configuration, it automatically selects a theme based on the current date or allows you to manually set a default theme.
|
Jellyfin Seasonals is a plugin that adds seasonal themes to your Jellyfin web interface. Depending on the configuration, it automatically selects a theme based on the current date or allows you to manually set a default theme.
|
||||||
|
|
||||||
This plugin is based on my manual mod (see the `manual` branch), which builds up on the awesome work of [BobHasNoSoul-jellyfin-mods](https://github.com/BobHasNoSoul/jellyfin-mods).
|
This plugin is based on my manual mod (see the [legacy branch](https://github.com/CodeDevMLH/Jellyfin-Seasonals/tree/legacy)), which builds up on the awesome work of [BobHasNoSoul-jellyfin-mods](https://github.com/BobHasNoSoul/jellyfin-mods).
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -13,7 +15,7 @@ This plugin is based on my manual mod (see the `manual` branch), which builds up
|
|||||||
- [Overview](#overview)
|
- [Overview](#overview)
|
||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
- [Usage](#usage)
|
- [Usage](#usage)
|
||||||
- [Automatic Selection Dates](#automatic-selection-dates)
|
- [Automatic Theme Selection](#automatic-theme-selection)
|
||||||
- [Build Process](#build-process)
|
- [Build Process](#build-process)
|
||||||
- [Contributing](#contributing)
|
- [Contributing](#contributing)
|
||||||
- [Legacy Manual Installation](#legacy-manual-installation)
|
- [Legacy Manual Installation](#legacy-manual-installation)
|
||||||
@@ -63,18 +65,20 @@ This plugin is based on my manual mod (see the `manual` branch), which builds up
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
This plugin is based on Jellyfin Version `10.11.x`
|
||||||
|
|
||||||
To install this plugin, you will first need to add the repository in Jellyfin.
|
To install this plugin, you will first need to add the repository in Jellyfin.
|
||||||
|
|
||||||
1. Open your Jellyfin Dashboard.
|
1. Open your Jellyfin Dashboard.
|
||||||
2. Navigate to **Plugins** > **Repositories**.
|
2. Navigate to **Plugins** > **Manage Repositories**.
|
||||||
3. Click the **+** sign to add a new repository.
|
3. Click the **+ New Repository** button to add a new repository.
|
||||||
4. Enter a name (e.g., "Seasonals") and paste the following URL into the 'Repository URL' field:
|
4. Enter a name (e.g., "Seasonals") and paste the following URL into the 'Repository URL' field:
|
||||||
```bash
|
```bash
|
||||||
https://raw.githubusercontent.com/CodeDevMLH/jellyfin-plugin-seasonals/main/manifest.json
|
https://raw.githubusercontent.com/CodeDevMLH/Jellyfin-Seasonals/refs/heads/main/manifest.json
|
||||||
```
|
```
|
||||||
5. Click **Save**.
|
5. Click **Add**.
|
||||||
6. Go to the **Catalog** tab at the top.
|
6. Go to the **Available** tab at the top.
|
||||||
7. Under **General**, find the **Seasonals** plugin.
|
7. Find the **Seasonals** plugin (Under **General**)
|
||||||
8. Click on it and select **Install**.
|
8. Click on it and select **Install**.
|
||||||
9. **Restart your Jellyfin server.**
|
9. **Restart your Jellyfin server.**
|
||||||
10. **You may need to refresh your browser page** (F5 or Ctrl+R) to see the changes.
|
10. **You may need to refresh your browser page** (F5 or Ctrl+R) to see the changes.
|
||||||
@@ -144,7 +148,7 @@ Feel free to contribute to this project by creating pull requests or reporting i
|
|||||||
<script src="seasonals/seasonals.js"></script>
|
<script src="seasonals/seasonals.js"></script>
|
||||||
```
|
```
|
||||||
2. **Deploy Files**
|
2. **Deploy Files**
|
||||||
Place the seasonals folder (including seasonals.js, CSS, and additional JavaScript files for each theme [this one](https://github.com/CodeDevMLH/Jellyfin-Seasonals/tree/main/seasonals)) inside the Jellyfin web server directory (labeld with "web").
|
Place the seasonals folder (including seasonals.js, CSS, and additional JavaScript files for each theme [this one](https://github.com/CodeDevMLH/Jellyfin-Seasonals/tree/legacy/seasonals)) inside the Jellyfin web server directory (labeld with "web").
|
||||||
|
|
||||||
3. **Configure Themes**
|
3. **Configure Themes**
|
||||||
Customize the theme-configs.js file to modify or add new themes. The default configuration is shown below:
|
Customize the theme-configs.js file to modify or add new themes. The default configuration is shown below:
|
||||||
|
|||||||
Reference in New Issue
Block a user