Merge pull request #25 from h1dden-da3m0n/chore/plugin-images

.github/workflows/codeql-analysis.yml

@@ -16,6 +16,7 @@ jobs:
   analyze:
     name: Analyze
     runs-on: ubuntu-latest
+    if: github.repository == 'jellyfin/jellyfin-plugin-fanart'
 
     strategy:
       fail-fast: false

.github/workflows/create-github-release.yml

@@ -7,6 +7,8 @@ on:
 jobs:
   publish_release_draft:
     runs-on: ubuntu-latest
+    if: github.repository == 'jellyfin/jellyfin-plugin-fanart'
+    
     steps:
       - name: Get version from GITHUB_REF
         id: get-version

.github/workflows/update-release-draft.yml

@@ -9,6 +9,8 @@ on:
 jobs:
   update_release_draft:
     runs-on: ubuntu-latest
+    if: github.repository == 'jellyfin/jellyfin-plugin-fanart'
+    
     steps:
       # Drafts your next Release notes as Pull Requests are merged into "master"
       - uses: release-drafter/release-drafter@v5.15.0

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-fanart.svg?sanitize=true"/>
 <br/>
 <br/>
 <a href="https://github.com/jellyfin/jellyfin-plugin-fanart/actions?query=workflow%3A%22Test+Build+Plugin%22">
@@ -17,19 +17,33 @@
 </p>
 
 ## About
+This plugin allows you to get images for your Movies and TV Shows from [Fanart](https://fanart.tv/).
 
-The Jellyfin Fanart plugin allows you to get images for your Movies and TV Shows from <a href="https://fanart.tv/">Fanart.</a>
+## Installation
 
-## Build & Installation Process
+[See the official documentation for install instructions](https://jellyfin.org/docs/general/server/plugins/index.html#installing).
 
-1. Clone this repository
+## Build
 
-2. Ensure you have .NET Core SDK set up and installed
+1. To build this plugin you will need [.Net 5.x](https://dotnet.microsoft.com/download/dotnet/5.0).
 
-3. Build the plugin with your favorite IDE or the `dotnet` command:
+2. Build plugin with following command
+  ```
+  dotnet publish --configuration Release --output bin
+  ```
 
-```
-dotnet publish --configuration Release --output bin
-```
+3. Place the dll-file in the `plugins/fanart` folder (you might need to create the folders) of your JF install
 
-4. Place the resulting `Jellyfin.Plugin.Fanart.dll` file in a folder called `plugins/` inside your Jellyfin data directory
+## 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.

build.yaml

@@ -1,6 +1,7 @@
 ---
 name: "Fanart"
 guid: "170a157f-ac6c-437a-abdd-ca9c25cebd39"
+imageUrl: "https://repo.jellyfin.org/releases/plugin/images/jellyfin-plugin-fanart.png"
 version: "6.0.0.0"
 targetAbi: "10.7.0.0"
 framework: "net5.0"
@@ -9,6 +10,6 @@ description: "Scrape poster images for movies, shows, and artists in your librar
 category: "Metadata"
 owner: "jellyfin"
 artifacts:
-- "Jellyfin.Plugin.Fanart.dll"
-changelog: >
+  - "Jellyfin.Plugin.Fanart.dll"
+changelog: |
   changelog