From 02a696c05f9f6a8d7681d287efa4d0fb3fed260e Mon Sep 17 00:00:00 2001
From: kawa <us.fame.sq@gmail.com>
Date: Wed, 26 Aug 2026 17:47:56 +0200
Subject: [PATCH] docs: add README with docker compose usage and dependency
 list

---
 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..11a73f7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# Ready2Blob
+
+A pure-frontend wizard that generates rclone config files and PowerShell deployment scripts for pushing cloud storage remotes onto Windows endpoints via Intune or any RMM tool. Supports 18 backends (Azure Blob, S3, S3-compatible, OneDrive, SFTP, GCS, Backblaze B2, Google Drive, Dropbox, Box, pCloud, FTP, WebDAV, SMB, HTTP, Seafile, Yandex Disk, Koofr). Everything runs client-side — no backend, no data leaves the browser.
+
+## Run with Docker Compose
+
+```yaml
+services:
+  ready2blob:
+    image: git.azuze.fr/kawa/ready2blob:latest
+    container_name: ready2blob
+    ports:
+      - "8080:80"
+    environment:
+      # "/" for a dedicated (sub)domain; "/ready2blob/" to mount under a path.
+      BASE_URL: "/"
+    restart: unless-stopped
+```
+
+```bash
+docker compose up -d
+```
+
+Then open `http://localhost:8080`.
+
+## Environment Variables
+
+| Variable | Default | Description |
+|----------|---------|-------------|
+| `BASE_URL` | `/` | Path the app is served from. Use `/` for a dedicated (sub)domain, or `/ready2blob/` to mount under a path on a shared host. |
+
+## Dependencies
+
+- [React 18](https://react.dev/) + [Vite 6](https://vitejs.dev/) + [TypeScript 5](https://www.typescriptlang.org/)
+- [Tailwind CSS v4](https://tailwindcss.com/)
+- [react-hook-form](https://react-hook-form.com/) + [@hookform/resolvers](https://github.com/react-hook-form/resolvers) + [Zod 4](https://zod.dev/) for form validation
+- [JSZip](https://stuk.github.io/jszip/) for ZIP bundle downloads
+- [Vitest](https://vitest.dev/) for testing
+- Runtime: [nginx](https://nginx.org/) (alpine) serving the static build