From e34b2642bf304f5aa6b6dadd954f35d0ef2c696a Mon Sep 17 00:00:00 2001
From: Tim <contact@bytim.eu>
Date: Tue, 22 Apr 2025 13:55:33 +0200
Subject: Add README.md

---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b705859
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# pics
+
+A simple image uploader for ShareX.
+
+## Setup
+1. Start the project using docker compose with ``docker compose up -d``
+2. Set the auth keys separated with a comma in the ``AUTH_KEYS`` variable in the ``.env``-File in the mounted data directory.
+3. Configure your ShareX
+
+### Example ShareX config
+![example config](https://pics.bytim.eu/src/jrwvvpxpsf.png)
-- 
cgit v1.2.3