From a9cd30364e8c00b49f41a5feec1e2d501552a806 Mon Sep 17 00:00:00 2001
From: Cucumberrbob <128094686+Cucumberrbob@users.noreply.github.com>
Date: Sun, 2 Feb 2025 15:06:27 +0000
Subject: [PATCH] Update `readme` to include Synology Download Station.
 Descriptions for configuration options taken from 047326a by YvesPa

---
 README.md | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 22eaffc..2bb7084 100644
--- a/README.md
+++ b/README.md
@@ -105,7 +105,7 @@ If you use Proxmox for your homelab, you can run rdt-client in a linux container
 
 ### Download Clients
 
-Currently there 4 available download clients:
+Currently there 5 available download clients:
 
 #### Internal Downloader
 
@@ -153,6 +153,17 @@ Required configuration:
 Suggested configuration:
 - Automatic retry downloads > 3
 
+### Synology Download Station
+
+The Synology Download Station downloader uses an external Download Station server. You will need to set this up yourself.
+
+It has the following options:
+
+- Url: The URL to the Synology DownloadStation. A common URL is `http://127.0.0.1:5000`
+- Username: The username to use when connecting to the Synology DownloadStation.
+- Password: The password to use when connecting to the Synology DownloadStation.
+- Download Path: The root path to download the file on the Synology DownloadStation host. If left empty, the default path configured on your Download Station server will be used.
+
 ### Troubleshooting
 
 - If you forgot your logins simply delete the `rdtclient.db` and restart the service.