chore: update readme and add example uploaders

castdrian · Dec 30, 2023 · c8602de · c8602de
1 parent a499987
commit c8602de
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 0 deletions.
diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,10 @@
+# iShare Examples
+
+This folder contains example uploader files for ishare.
+
+## 📤 Compatible Uploader Services
+
+ishare is confirmed to be compatible with the following uploader services:
+
+- [chibisafe](https://github.com/chibisafe/chibisafe)
+- [lumen](https://github.com/ChecksumDev/lumen)
diff --git a/examples/chibisafe.iscu b/examples/chibisafe.iscu
@@ -0,0 +1,9 @@
+{
+  "name": "chibisafe",
+  "requestUrl": "https://chibisafe.moe/api/upload",
+  "headers": { 
+    "x-api-key": "API_KEY" 
+  },
+  "fileFormName": "file[]",
+  "responseURL": "{{url}}"
+}
diff --git a/examples/lumen.iscu b/examples/lumen.iscu
@@ -0,0 +1,11 @@
+{
+  "name": "lumen",
+  "requestUrl": "http://localhost:8080/upload",
+  "headers": {
+    "x-api-key": "API_KEY"
+  },
+  "requestBodyType": "binary",
+  "responseURL": "http://localhost:8080/{{id}}.{{ext}}?key={{key}}&nonce={{nonce}}",
+  "deletionURL": "http://localhost:8080/{{id}}.{{ext}}/delete?key={{key}}&nonce={{nonce}}&api_key=API_KEY"
+}
+