diff --git a/homebox/README.mc b/homebox/README.md similarity index 96% rename from homebox/README.mc rename to homebox/README.md index a1f8de7..190380d 100644 --- a/homebox/README.mc +++ b/homebox/README.md @@ -33,24 +33,16 @@ Homebox is a **home inventory management system** built for the Home User. It he ## 🚀 Quick Start -### Step 1️⃣: Configure Environment +### Step 1️⃣: Create docker-compose.yml ```bash -cd services/homebox -cp .env.example .env -# Edit .env with your settings +touch docker-compose.yml ``` - -> 💡 **Tip**: You can disable registration after creating your account by setting `HBOX_OPTIONS_ALLOW_REGISTRATION=false` - ### Step 2️⃣: Start Service ```bash -# From services/homebox directory +# homebox directory docker-compose up -d - -# Or from repository root -docker-compose -f services/homebox/docker-compose.yml up -d ``` ### Step 3️⃣: Access Homebox