From 0a5b01f69427d0fa9b2cac71070ca5c49fd4448f Mon Sep 17 00:00:00 2001
From: Mikkel RINGAUD <mikkel@milescode.dev>
Date: Fri, 11 Aug 2023 17:56:21 +0200
Subject: [PATCH] docs: add instructions for ShareX

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

diff --git a/README.md b/README.md
index b96a0e4..ba27168 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,66 @@
 # Drive, a cattolabs alternative
 
+## Using the API
+
+> Available @ <https://drive.cattolabs.com/api>
+
+We provide an accessible API for interacting with the drive. In fact, we use that exact same API in the front-end of the web app.
+
+You can use the API as unauthenticated (anonymous) or [authenticated](#how-to-authenticate).
+
+### Differences between anonymous and authenticated users on the API
+
+|     | Unauthenticated | Authenticated |
+| --- | --------------- | ------------- |
+| Upload files | ✅ Yes | ✅ Yes |
+| Access public files | ✅ Yes | ✅ Yes |
+| Upload files in a workspace | ❌ No | ✅ Yes |
+| Create workspaces | ❌ No | ✅ Yes |
+| Remove uploaded file later - with no self destruct option | ❌ No | ✅ Yes |
+| Access private files - if user is allowed | ❌ No | ✅ Yes |
+
+### How to authenticate ?
+
+If you do have an account, head over the "My Account" page and
+grab your "API Token" from there.
+
+Now, if every requests you make to the API, just add the `Authorization` header, where its value is the API token you got from earlier.
+
+#### Simple example using `fetch`
+
+```typescript
+const response = await fetch("https://drive.cattolabs.com/api/...", {
+  // ...
+  headers: {
+    authorization: "api-token-you-got-here"
+  }
+});
+```
+
+### Get a workspace ID
+
+> TODO
+
+### Integration with [ShareX](https://getsharex.com/)
+
+[ShareX](https://getsharex.com/) is a screen capture, file sharing app. Using our API, you can easily upload your files in your workspace.
+
+To use [drive.cattolabs.com](https://drive.cattolabs.com) with ShareX, you have to setup a custom uploader.
+
+1. Head over to "Destinations" > "Custom uploader settings" ;
+1. Click on "New" to create a new uploader. Name it as you want, we'll go with `drive.cattolabs.com` here ;
+1. Set the "Destination type" to `Image uploader` and `File uploader`, we currently don't support `Text uploader` ;
+1. Set the "Method" to `PUT` ;
+1. Set the "Request URL" to `https://drive.cattolabs.com/api/files` ;
+1. Keep "URL parameters" empty ;
+1. For "Headers", leave empty if you want to upload as anonymous, else add `Authorization` and as value, [your API key](#using-the-api) ;
+1. Keep "Body" as `Form data (multipart/form-data)`, below you're able to add form data parameters
+  - `private` as name and `0` as value to make all your uploaded files public.
+  - If you're authenticated, uploaded files will be at the root of your drive by default, you can override that behavior by adding `workspace_id` as name and [any workspace ID](#get-a-workspace-id) as value to make all uploads go there.
+8. Set the "File form name" to `files` ;
+1. Set the "URL" to `https://drive.cattolabs.com/api/file/{json:data.uploaded[0].id}`
+1. Set the "Error message" to `{json:message}`
+
 ## Developing
 
 ```bash