From 8e8225c26ebf6580a2bed281b197bddf70924587 Mon Sep 17 00:00:00 2001 From: BlackSigkill Date: Fri, 6 Feb 2026 16:59:36 +0100 Subject: [PATCH] add Docker part (with link to future howto) in the README --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f4c5f6d..6894749 100644 --- a/README.md +++ b/README.md @@ -107,12 +107,25 @@ For alternative instances, check [INSTANCES.md](INSTANCES.md). NOTE: Accounts wont work on self-hosted instances. -### Prerequisites +### Option 1: Docker (Recommended) + +```bash +git clone https://github.com/monochrome-music/monochrome.git +cd monochrome +docker compose up -d +``` + +Visit `http://localhost:3000` + +For PocketBase, development mode, and advanced setups, see [DOCKER.md](DOCKER.md). + +### Option 2: Manual Installation +#### Prerequisites - [Node.js](https://nodejs.org/) (Version 20+ or 22+ recommended) - [Bun](https://bun.sh/) or [npm](https://www.npmjs.com/) -### Local Development +#### Local Development 1. **Clone the repository:** @@ -140,7 +153,7 @@ NOTE: Accounts wont work on self-hosted instances. 4. **Open your browser:** Navigate to `http://localhost:5173/` -### Building for Production +#### Building for Production ```bash bun run build