aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-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)