From 789f07100e3f329119104022dda671e794595fb6 Mon Sep 17 00:00:00 2001
From: Ulas
Date: Thu, 2 Apr 2026 14:45:02 +0200
Subject: [PATCH] docs: refine README structure and Quick Start section
Separate docker compose and setup steps for clarity, remove redundant
horizontal rules, split License into its own section per style guide.
Co-Authored-By: Claude Opus 4.6
---
README.md | 27 +++++++++------------------
1 file changed, 9 insertions(+), 18 deletions(-)
diff --git a/README.md b/README.md
index c1f9121..55be205 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@
Self-hosted family planner for small households
Tasks · Shopping Lists · Meal Planning · Calendar Sync · Budget · Notes · Contacts
-
+
@@ -41,8 +41,6 @@
Toggle GitHub light/dark mode to see both themes.
----
-
## Highlights
📋 **Task Management** — Shared tasks with deadlines, priorities, subtasks, recurring schedules, and Kanban view
@@ -65,22 +63,21 @@
🌍 **Multilingual** — German and English UI with automatic locale detection
----
-
## Quick Start
```bash
-git clone https://github.com/ulsklyc/oikos.git && cd oikos
-cp .env.example .env # Set SESSION_SECRET (≥32 chars)
-docker compose up -d # First build takes ~3 min (compiles SQLCipher)
-docker compose exec oikos node setup.js # Create admin account
+docker compose up -d
```
-Open `http://localhost:3000` — add family members from Settings.
+Then open `http://localhost:3000` and run the setup:
-> For HTTPS and reverse proxy setup, see [`nginx.conf.example`](nginx.conf.example).
+```bash
+docker compose exec oikos node setup.js
+```
----
+Add family members from Settings.
+
+> See [`nginx.conf.example`](nginx.conf.example) for HTTPS and reverse proxy setup.
## Tech Stack
@@ -93,15 +90,11 @@ Open `http://localhost:3000` — add family members from Settings.
----
-
## Documentation
| 📖 [Spec & Data Model](docs/SPEC.md) | 🤝 [Contributing](CONTRIBUTING.md) | 🔒 [Security](SECURITY.md) | 📋 [Changelog](CHANGELOG.md) | 📌 [Backlog](BACKLOG.md) |
|---|---|---|---|---|
----
-
## Roadmap
✅ Core modules — Dashboard, Tasks, Shopping, Meals, Calendar, Notes, Contacts, Budget
@@ -114,8 +107,6 @@ Open `http://localhost:3000` — add family members from Settings.
📋 Household inventory tracking
----
-
## License