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

update readme

Browse Source
This commit is contained in:
h1dden-da3m0n 2021-03-19 00:13:38 +01:00
parent 49c4d1fd9f
commit 7faaddf03a
1 changed files with 31 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -2,7 +2,7 @@
<h3 align="center">Part of the <a href="https://jellyfin.media">Jellyfin Project</a></h3>
<p align="center">
<img alt="Logo Banner" src="https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/branding/SVG/banner-logo-solid.svg?sanitize=true"/>
<img alt="Plugin Banner" src="https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/plugins/SVG/jellyfin-plugin-trakt.svg?sanitize=true"/>
<br/>
<br/>
<a href="https://github.com/jellyfin/jellyfin-plugin-trakt/actions?query=workflow%3A%22Test+Build+Plugin%22">
@ -17,4 +17,34 @@
</p>
## About
Available for install through the plugin catalog, Trakt for Jellyfin allows you to synchronize your watch states with ease.
## Installation
[See the official documentation for install instructions](https://jellyfin.org/docs/general/server/plugins/index.html#installing).
## Build
1. To build this plugin you will need [.Net 5.x](https://dotnet.microsoft.com/download/dotnet/5.0).
2. Build plugin with following command
```
dotnet publish --configuration Release --output bin
```
3. Place the dll-file in the `plugins/trakt` 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 MIT License. See [LICENSE](./LICENSE.md) for more information.