From ffc6c28304bc710e1151c0286e9336ead5244eb3 Mon Sep 17 00:00:00 2001
From: Clawd <ai@clawd.bot>
Date: Sat, 28 Feb 2026 18:21:09 -0800
Subject: Simplify README: focus on workflow, git integration, session
 structure

---
 README.md | 97 ++++++++++++++++-----------------------------------------------
 1 file changed, 24 insertions(+), 73 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 5405f63..d109333 100644
--- a/README.md
+++ b/README.md
@@ -2,101 +2,52 @@
 
 A document-centric coding assistant that enforces a structured workflow: **Research → Plan → Implement**.
 
-Built with Electron, React, TypeScript, better-sqlite3, and the Claude Agent SDK.
+Built with Electron, React, and the Claude Agent SDK.
 
-## Concept
+## Workflow
 
-The primary UI is a **markdown document viewer/editor** with a **chat sidebar**. The workflow is driven by the document, not the chat.
+1. **Research** — Claude analyzes your codebase, writes findings to session `research.md`
+2. **Plan** — Claude creates an implementation plan with code snippets and TODO checklist
+3. **Implement** — Claude executes the plan, committing as it goes
 
-### Workflow Phases
+At each phase, edit the document to add notes (`// REVIEW:`, `// NOTE:`), click **Review** for feedback, then **Submit** to advance.
 
-1. **Research** — Claude researches your codebase based on your direction, writing findings to `.claude-flow/research.md`
-2. **Plan** — Claude creates a detailed implementation plan in `.claude-flow/plan.md` with code snippets and a TODO checklist
-3. **Implement** — Claude executes the plan, marking tasks complete as it goes
+## Git Integration
 
-At each phase, you can edit the document to add notes (marked with `// REVIEW:` or `// NOTE:`), click **Review** to have Claude address your feedback, then **Submit** to advance to the next phase.
-
-## UI Layout
+Each session creates an isolated git worktree:
 
 ```
-┌──────────────────────────────────────────────────────────────┐
-│ [Project ▾]  [Session ▾]              [Research ● ─ Plan ─]  │
-├────────────────────────────────────────┬─────────────────────┤
-│                                        │                     │
-│   # Research Findings                  │   Chat Dialogue     │
-│                                        │                     │
-│   ## Authentication System             │   Claude: What      │
-│                                        │   should I research?│
-│   The auth module uses JWT...          │                     │
-│                                        │   You: Research the │
-│   // REVIEW: check OAuth too           │   auth system       │
-│                                        │                     │
-├────────────────────────────────────────┼─────────────────────┤
-│  42k / 200k tokens ████░░░░            │         [Send]      │
-│                     [Review]  [Submit] │                     │
-└────────────────────────────────────────┴─────────────────────┘
+.claude-flow/
+├── sessions/{sessionId}/
+│   ├── research.md        # Session-specific research
+│   └── plan.md            # Session-specific plan
+└── worktrees/{sessionId}/ # Git worktree (branch: claude-flow/{sessionId})
 ```
 
-## Requirements
-
-- Node.js ≥ 18
-- macOS (Apple Silicon or Intel), Windows, or Linux
-- Claude API key or Claude Code subscription
+- Concurrent sessions supported — each has its own branch
+- Implementation commits incrementally
+- Review in worktree, then merge or discard
 
-## Install
+## Shared Context
 
-```bash
-git clone <this-repo>
-cd claude-flow
-npm install
-```
+`CLAUDE.md` at project root holds persistent codebase documentation shared across all sessions. Claude reads it at the start and updates it with new architectural insights.
 
-## Development
+## Setup
 
 ```bash
+npm install
+export ANTHROPIC_API_KEY=your-key
 npm run dev
 ```
 
-This starts Vite dev server and Electron in watch mode.
-
-## Build
-
-```bash
-npm run dist
-```
-
-Creates distributable builds via electron-builder.
-
-## Project Structure
-
-```
-claude-flow/
-├── src/main/           # Electron main process
-│   ├── index.ts        # App lifecycle, window management
-│   ├── preload.ts      # IPC bridge with typed API
-│   ├── db/             # SQLite database (projects, sessions, messages)
-│   ├── claude/         # Claude SDK wrapper with phase configs
-│   └── ipc/            # IPC handlers
-├── renderer/           # React frontend
-│   ├── src/
-│   │   ├── App.tsx           # Main app with state management
-│   │   ├── components/       # Header, DocumentPane, ChatPane, ActionBar
-│   │   ├── styles/           # CSS
-│   │   └── types.ts          # TypeScript types
-│   └── index.html
-├── package.json
-├── tsconfig.json
-└── vite.config.ts
-```
-
 ## Keyboard Shortcuts
 
-- **Cmd/Ctrl + Enter** — Submit (advance to next phase)
-- **Escape** — Interrupt Claude
+- **Cmd/Ctrl + Enter** — Submit
+- **Escape** — Interrupt
 
 ## References
 
-- [How I Use Claude Code](https://boristane.com/blog/how-i-use-claude-code/) — Boris Tane's post on the Research → Plan → Implement workflow
+- [How I Use Claude Code](https://boristane.com/blog/how-i-use-claude-code/) — Boris Tane's post that inspired this workflow
 
 ## License
 
-- 
cgit v1.2.3