Update README.

2026-04-20 21:43:05 +10:00
1 changed files with 21 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -2,6 +2,27 @@
 A plugin for [Kirby](https://getkirby.com) that provides a bridge between the [Deluge BitTorrent Client](https://deluge-torrent.org) and the [Jellyfin Media Player](https://jellyfin.org).
 ## Usage
 - Create a new `deluge` page.
 - Fill out the Deluge URL and password along with the speeds desired.
  - Minimums are used when there **ARE** Jellyfin streams active.
  - Maximums are used when there are **NO** Jellyfin streams active.
  - Max time at min speed defines a timeout for streams that may be paused or aren't stopped properly.
 - Generate and fill out the Jellyfin API key and Jellyfin URL.
 - Use the `Webhook` plugin in Jellyfin to create 2 webhooks:
  - First hook:
    - URL: `https://website.url/deluge?s=inc`
    - Notification Type: `Playback Start`
    - Set `Item Types` and `User Filter`'s.
  - Second hook:
    - URL: `https://website.url/deluge?s=dec`
    - Notification Type: `Playback Stop`
    - Match `Item Types` and `User Filter`'s above.
 - Test connecting to Deluge by visiting the page and using the buttons.
 - Test connecting to Jellyfin by visiting Jellyfin, starting a stream and checking the page.
 # License
 Kirby Deluge is Copyright 2026, [Dreytac](mailto:dreytac@hobbyhome.net).