jellyfin/jellyfin-plugin-kodisyncqueue
1
0
Fork 0
mirror of https://github.com/jellyfin/jellyfin-plugin-kodisyncqueue.git synced 2024-11-26 23:10:26 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
h1dden-da3m0n 2021-03-19 18:07:24 +01:00
parent 2c7fcb349d
commit 469302f220
1 changed files with 38 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -1,20 +1,49 @@
<h1 align="center">Jellyfin Kodi Sync Queue Plugin</h1>
<h3 align="center">Part of the <a href="https://jellyfin.org">Jellyfin Project</a></h3>
## About
<p align="center">
<img alt="Plugin Banner" src="https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/plugins/SVG/jellyfin-plugin-kodisyncqueue.svg?sanitize=true"/>
<br/>
<br/>
<a href="https://github.com/jellyfin/jellyfin-plugin-kodisyncqueue/actions?query=workflow%3A%22Test+Build+Plugin%22">
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/jellyfin/jellyfin-plugin-kodisyncqueue/Test%20Build%20Plugin.svg">
</a>
<a href="https://github.com/jellyfin/jellyfin-plugin-kodisyncqueue">
<img alt="GPLv2 License" src="https://img.shields.io/github/license/jellyfin/jellyfin-plugin-kodisyncqueue.svg"/>
</a>
<a href="https://github.com/jellyfin/jellyfin-plugin-kodisyncqueue/releases">
<img alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin-plugin-kodisyncqueue.svg"/>
</a>
</p>
## About
This plugin will track all media changes while any Kodi clients are offline to decrease sync times when logging back in to your server.
## Build & Installation Process
## Installation
1. Clone this repository
[See the official documentation for install instructions](https://jellyfin.org/docs/general/server/plugins/index.html#installing).
2. Ensure you have .NET Core SDK set up and installed
## Build
3. Build the plugin with your favorite IDE or the `dotnet` command
1. To build this plugin you will need [.Net 5.x](https://dotnet.microsoft.com/download/dotnet/5.0).
```sh
dotnet publish --configuration Release --output bin
```
2. Build plugin with following command
```
dotnet publish --configuration Release --output bin
```
4. Place the resulting file in a folder called `plugins` in the data directory
3. Place the dll-file in the `plugins/kodisyncqueue` folder (you might need to create the folders) of your JF install
## Releasing
To release the plugin we recommend [JPRM](https://github.com/oddstr13/jellyfin-plugin-repository-manager) that will build and package the plugin.
For additional context and for how to add the packaged plugin zip to a plugin manifest see the [JPRM documentation](https://github.com/oddstr13/jellyfin-plugin-repository-manager) for more info.
## Contributing
We welcome all contributions and pull requests! If you have a larger feature in mind please open an issue so we can discuss the implementation before you start.
In general refer to our [contributing guidelines](https://github.com/jellyfin/.github/blob/master/CONTRIBUTING.md) for further information.
## Licence
This plugins code and packages are distributed under the GPLv2 License. See [LICENSE](./LICENSE) for more information.