Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
revam committed Aug 30, 2021
1 parent 5bb0008 commit b420bb0
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
# Shokofin

**Warning**: This plugin currently requires the latest version of Jellyfin (`>10.7.0`) and daily version of Shoko (`>4.1.0`) to be installed to work.
**Warning**: This plugin requires a version of Jellyfin after 10.7 (`>=10.7.0`) and a stable version of Shoko after 4.1.1 (`>=4.1.1`) to be installed to work properly.

A plugin to integrate your Shoko database with the Jellyfin media server.

## Breaking Changes

### 1.5.0

If you're upgrading from an older version to version 1.5.0, then be sure to update the "Host" field in the plugin settings before you continue using the plugin.

## Install

There are multiple ways to install this plugin, but the recomended way is to use the official Jellyfin repository.
Expand All @@ -12,16 +18,19 @@ There are multiple ways to install this plugin, but the recomended way is to use

1. Go to Dashboard -> Plugins -> Repositories
2. Add new repository with the following details
* Repository Name: `Shokofin`
* Repository Name: `Shokofin Stable`
* Repository URL: `https://raw.githubusercontent.com/ShokoAnime/Shokofin/master/manifest.json`
3. Go to the catalog in the plugins page
4. Find and install Shokofin from the Metadata section
5. Restart your server to apply the changes.

### Github Releases

1. Download the `shokofin_*.zip` file from the latest release from GitHub [here](https://github.com/ShokoAnime/shokofin/releases/latest).

2. Extract the contained `Shokofin.dll` and `meta.json`, place both the files in a folder named `Shokofin` and copy this folder to the `plugins` folder under the Jellyfin program data directory or inside the portable install directory.
2. Extract the contained `Shokofin.dll` and `meta.json`, place both the files in a folder named `Shokofin` and copy this folder to the `plugins` folder under the Jellyfin program data directory or inside the portable install directory. Refer to the "Data Directory" section on [this page](https://jellyfin.org/docs/general/administration/configuration.html) for where to find your jellyfin install.

3. Start or restart your server to apply the changes

### Build Process

Expand Down

0 comments on commit b420bb0

Please sign in to comment.