mirror of
https://github.com/jellyfin/jellyfin-plugin-tvheadend.git
synced 2024-11-23 13:49:40 +00:00
update readme
This commit is contained in:
parent
19697e53e3
commit
459209d1de
32
README.md
32
README.md
@ -2,7 +2,7 @@
|
||||
<h3 align="center">Part of the <a href="https://jellyfin.org">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-tvheadend.svg?sanitize=true"/>
|
||||
<br/>
|
||||
<br/>
|
||||
<a href="https://github.com/jellyfin/jellyfin-plugin-tvheadend/actions?query=workflow%3A%22Test+Build+Plugin%22">
|
||||
@ -17,4 +17,34 @@
|
||||
</p>
|
||||
|
||||
## About
|
||||
|
||||
This is a plugin allows you to manage TVHeadend from Jellyfin.
|
||||
|
||||
## 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/tvheadend` 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) for more information.
|
||||
|
Loading…
Reference in New Issue
Block a user