From 8d03ac3fcc976333c25858c1537f3538e4921df0 Mon Sep 17 00:00:00 2001
From: juliaweber <julia.weber@db-extern.de>
Date: Tue, 16 Jun 2026 17:14:52 +0200
Subject: [PATCH] docs: add README with Features section and quick-start guide

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..79e53f5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# OSDB — Obstsortendatenbank
+
+A full-stack fruit-variety database (Go + Vue 3).
+
+## Features
+
+- Users can view a "Hello, OSDB!" landing page that confirms the backend is reachable via the Vite proxy.
+
+## Quick Start
+
+```bash
+cp .env.example .env          # set credentials
+make dev-db                   # start Postgres (waits until healthy)
+make migrate-up               # apply schema migrations
+make run-backend              # Echo API on :3000
+make run-frontend             # Vite dev server on :5000
+```
+
+## Testing
+
+```bash
+make test
+```