From 2261a964363a6b8371c7496c32879c22724d6751 Mon Sep 17 00:00:00 2001
From: Pavel Fadeev <pavel.fadeev@gmail.com>
Date: Fri, 15 May 2026 23:28:41 +0200
Subject: [PATCH] docs: add Quickstart section with install, init, run, and
 train flow

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/README.md b/README.md
index 80b549b..d8bcc21 100644
--- a/README.md
+++ b/README.md
@@ -7,10 +7,29 @@
 
 Local project-memory engine for git history.
 
+## Quickstart
+
 ```bash
 npm install -g @fiale-plus/repo-arch
+
+cd your-project
+export OPENAI_API_KEY=sk-...   # or GEMINI_API_KEY
+
+repo-arch init                  # write starter config
+repo-arch flow run --repo .     # mine history → cards → dataset
+repo-arch flow inspect --repo . # see what was produced
+```
+
+Then curate and train:
+
+```bash
+repo-arch review list           # review generated cards
+repo-arch accept <card-id>      # mark valuable cards
+repo-arch train run --repo .    # fine-tune on accepted cards
 ```
 
+Requires Node 18+ and (for training) Apple Silicon with MLX.
+
 Repo-Arch mines repository history, classifies commit signals, builds cards, explains files, warns on diffs, checks staleness, runs similarity search, prepares evals, and generates training data.
 
 ## Pi install