aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim <contact@bytim.eu>2025-04-22 13:55:33 +0200
committerTim <contact@bytim.eu>2025-04-22 13:55:33 +0200
commite34b2642bf304f5aa6b6dadd954f35d0ef2c696a (patch)
tree7dbb871a52306b02b8e738861f147ded2fa27bbd
parent364d2dbdcff8bbc368ab4e858f5a5624ba1c2f7d (diff)
downloadpics-e34b2642bf304f5aa6b6dadd954f35d0ef2c696a.tar.xz
pics-e34b2642bf304f5aa6b6dadd954f35d0ef2c696a.zip
Add README.md
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
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)