From a00a5fbcb9324e5717b8d5536eba89011c9d6092 Mon Sep 17 00:00:00 2001
From: Daniil Tsivinsky <daniil@tsivinsky.com>
Date: Sat, 21 Feb 2026 20:00:31 +0300
Subject: [PATCH] add readme

---
 readme.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..f4d9716
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,24 @@
+# oauth2-proxy
+
+## usage
+
+example docker-compose config for raindrop api.
+
+```docker-compose
+  raindrop-api:
+    image: git.zatch.ru/tsivinsky/oauth2-proxy:latest
+    container_name: raindrop-api
+    restart: unless-stopped
+    expose:
+      - 5000
+    environment:
+      - AUTH_CONFIG=/config/config.json
+      - CLIENT_ID={raindrop client_id}
+      - CLIENT_SECRET={raindrop client_secret}
+      - REDIRECT_URI={url to this service}/oauth/callback
+      - API_URL=https://api.raindrop.io/rest/v1
+      - AUTH_URL=https://raindrop.io/oauth/authorize
+      - TOKEN_URL=https://raindrop.io/oauth/access_token
+    volumes:
+      - ./data/raindrop-api:/config
+```