From a859bb282e66fc5a77dad3ebc8b5127615bff813 Mon Sep 17 00:00:00 2001
From: Jamie <1+jamie@noreply.jdbnet.co.uk>
Date: Wed, 20 May 2026 23:23:36 +0100
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..79e8220
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+<div align="center">
+  <img src="https://assets.jdbnet.co.uk/projects/s3.png" alt="JDB-NET" width="200" />
+  
+  # S3 Client
+
+A Flask + Vue app for managing S3 and S3-compatible storage with credentials stored in MariaDB.
+
+</div>
+
+## Features
+
+- Encrypted credential storage in MariaDB
+- Folder-based organization of S3 accounts
+- Bucket discovery and object browser
+- Upload, download, rename, delete, and folder creation for objects
+- Vue + Tailwind UI
+
+## Docker Compose
+
+```yaml
+services:
+  app:
+    image: cr.jdbnet.co.uk/public/s3-client:latest
+    ports:
+      - "5000:5000"
+    environment:
+      SECRET_KEY: "<YOUR_SECRETKEY>"
+      SESSION_DAYS: "14"
+      SESSION_COOKIE_SECURE: "false" # True if using HTTPS
+      WEBAPP_USERNAME: "<YOUR_USERNAME>"
+      WEBAPP_PASSWORD: "<YOUR_PASSWORD>"
+      DB_ENCRYPTION_KEY: "<YOUR_ENCRYPTION_KEY>"
+      MYSQL_HOST: "<YOUR_MYSQL_HOST>"
+      MYSQL_PORT: "<YOUR_MYSQL_PORT>"
+      MYSQL_DATABASE: "<YOUR_MYSQL_DB>"
+      MYSQL_USER: "<YOUR_MYSQL_USER>"
+      MYSQL_PASSWORD: "<YOUR_MYSQL_PASSWORD>"
+    restart: unless-stopped
+```
\ No newline at end of file