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

update readme

Browse Source
This commit is contained in:
h1dden-da3m0n 2021-03-18 23:46:05 +01:00
parent 2641aa56c2
commit 98bc9e3db9
1 changed files with 23 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -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-reports.svg?sanitize=true"/>
<br/>
<br/>
<a href="https://github.com/jellyfin/jellyfin-plugin-reports/actions?query=workflow%3A%22Test+Build+Plugin%22">
@ -18,27 +18,35 @@
## About
The Jellyfin Reports plugin generates activity and media reports for your library.
This plugin generates activity and media reports for your library.
These reports can be exported to Excel and CSV formats.
## Installation via Plugin Repository
## Installation
1. Open the Jellyfin Server Dashboard
2. Go to Plugins
3. In the Catalogue menu on the top search the "Reports" plugin and install it
4. Restart the server and the plugin will be available in the Advanced section in the server Dashboard.
[See the official documentation for install instructions](https://jellyfin.org/docs/general/server/plugins/index.html#installing).
## Build & Manual Installation Process
## Build
1. Clone this repository
1. To build this plugin you will need [.Net 5.x](https://dotnet.microsoft.com/download/dotnet/5.0).
2. Ensure you have .NET Core SDK set up and installed
2. Build plugin with following command
```
dotnet publish --configuration Release --output bin
```
3. Build the plugin with your favorite IDE or the `dotnet` command:
3. Place the dll-file in the `plugins/reports` folder (you might need to create the folders) of your JF install
```
dotnet publish --configuration Release --output bin
```
## Releasing
4. Place the resulting `Jellyfin.Plugin.Reports.dll` file in a folder called `plugins/` inside your Jellyfin data directory
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.