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

update readme

Browse Source
This commit is contained in:
h1dden-da3m0n 2021-03-18 21:16:07 +01:00
parent 0cf6f55eaf
commit a431c7734b
1 changed files with 35 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -2,18 +2,44 @@
<h3 align="center">Part of the <a href="https://jellyfin.media">Jellyfin Project</a></h3>
<p align="center">
This plugin is built with .NET Core to download metadata for anime.
<img alt="Plugin Banner" src="https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/plugins/SVG/jellyfin-plugin-anidb.svg?sanitize=true"/>
<br/>
<br/>
<a href="https://github.com/jellyfin/jellyfin-plugin-anidb/actions?query=workflow%3A%22Test+Build+Plugin%22">
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/jellyfin/jellyfin-plugin-anidb/Test%20Build%20Plugin.svg">
</a>
<a href="https://github.com/jellyfin/jellyfin-plugin-anidb/blob/master/LICENSE">
<img alt="GPLv2 License" src="https://img.shields.io/github/license/jellyfin/jellyfin-plugin-anidb.svg"/>
</a>
<a href="https://github.com/jellyfin/jellyfin-plugin-anidb/releases">
<img alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin-plugin-anidb.svg"/>
</a>
</p>
## Build Process
## About
This plugin adds the metadata provider for [aniDB](https://anidb.net/).
1. Clone or download this repository
## Build
2. Ensure you have .NET Core SDK setup and installed
1. To build this plugin you will need [.Net 5.x](https://dotnet.microsoft.com/download/dotnet/5.0).
3. Build plugin with following command.
2. Build plugin with following command
```
dotnet publish --configuration Release --output bin
```
```sh
dotnet publish --configuration Release --output bin
```
4. Place the resulting file in the `plugins` folder under the program data directory or inside the portable install directory
3. Place the dll-file in the `plugins/anidb` 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.