From f53dd65d2312875d71f0d0fbc058c667a1a85daf Mon Sep 17 00:00:00 2001
From: Chloe A <solely@riseup.net>
Date: Thu, 21 Dec 2023 17:43:51 +0600
Subject: [PATCH] Add ShareX integration in README (#20)

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/README.md b/README.md
index 7085490..2bf0ea7 100644
--- a/README.md
+++ b/README.md
@@ -137,6 +137,31 @@ You can set `limit` in the query string to `0` to retrieve all URLs.
 You can also view URLs from your Cloudflare Dashboard:
 `Cloudflare Dashboard -> Workers -> KV -> View` on the namespace.
 
+## ShareX
+
+To use worker-links as a URL Shortener in ShareX, create a file with a `.sxcu` extension (ex. `worker-links.sxcu`) and copy-paste the following:
+
+```json
+{
+  "Version": "15.0.0",
+  "Name": "worker-links",
+  "DestinationType": "URLShortener",
+  "RequestMethod": "POST",
+  "RequestURL": "https://erisa.link",
+  "Headers": {
+    "Authorization": "mysecret",
+    "URL": "{input}"
+  },
+  "Body": "JSON",
+  "URL": "{json:shorturl}"
+}
+```
+
+Replace `RequestURL` with the URL of your choice and `Authorization` with your worker link's secret.
+
+Now open the `.sxcu` file. It should make worker-links as your active custom URL Shortener.  
+If not, click on **Destinations** -> **URL Shortener** and choose **Custom URL Shortener**.
+
 ## Plausible Analytics
 
 To get statistics for your short URLs with Plausible Analytics, define a `PLAUSIBLE_HOST` secret set to the URL of your Plausible instance. For example, `https://plausible.io/`.