From 7faaddf03a640b9427b5e6055e8ce95e394f41c4 Mon Sep 17 00:00:00 2001
From: h1dden-da3m0n <33120068+h1dden-da3m0n@users.noreply.github.com>
Date: Fri, 19 Mar 2021 00:13:38 +0100
Subject: [PATCH] update readme
---
README.md | 32 +++++++++++++++++++++++++++++++-
1 file changed, 31 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index ea3002c..91e0965 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
-
+
@@ -17,4 +17,34 @@
## 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.