Skip to content

Commit 664d1a7

Browse files
committed
docs: split mermaid into 3 diagrams (Option A/B/C), fix Quick Start numbering
1 parent 0b79164 commit 664d1a7

1 file changed

Lines changed: 27 additions & 21 deletions

File tree

README.md

Lines changed: 27 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -22,40 +22,46 @@ AI-powered Oktoberfest reservation monitor — watches 38 beer tent portals, ale
2222

2323
Three ways to use Wiesn-Agent:
2424

25+
**Option A — Web Dashboard** (`wiesn-agent web` / Docker)
26+
27+
```mermaid
28+
graph LR
29+
SCAN["🔍 Scanner\n38 portals"] -->|found slots| DASH["🍺 Dashboard"]
30+
DASH -->|approve| FILL["🤖 AI pre-fills form"]
31+
FILL -->|never submits| YOU["✋ You click submit"]
32+
DASH -->|decline| SCAN
33+
```
34+
35+
**Option B — MCP Tools** (VS Code Copilot, Claude Desktop, Cursor, …)
36+
37+
```mermaid
38+
graph LR
39+
AI["💬 Copilot / Claude"] -->|MCP| TOOLS["15 browser tools"]
40+
TOOLS --> YOU["✋ You click submit"]
41+
```
42+
43+
**Option C — CLI Workflow** (`wiesn-agent once/watch`)
44+
2545
```mermaid
26-
graph TD
27-
subgraph "① Web Dashboard"
28-
SCAN["🔍 Scanner\n38 portals"] -->|found slots| DASH["🍺 Dashboard"]
29-
DASH -->|approve| FILL["🤖 AI pre-fills form"]
30-
FILL -->|never submits| YOU["✋ You click submit"]
31-
DASH -->|decline| SCAN
32-
end
33-
34-
subgraph "② MCP Tools"
35-
AI["💬 Copilot / Claude"] -->|MCP| TOOLS["15 browser tools"]
36-
TOOLS --> YOU2["✋ You click submit"]
37-
end
38-
39-
subgraph "③ CLI Workflow"
40-
MON["Monitor"] --> ANA["Analyzer"] --> NOT["Notifier"] --> APP["You approve?"]
41-
APP -->|yes| FILL2["Filler"]
42-
APP -->|no| MON
43-
end
46+
graph LR
47+
MON["Monitor"] --> ANA["Analyzer"] --> NOT["Notifier"] --> APP["You approve?"]
48+
APP -->|yes| FILL["Filler"]
49+
APP -->|no| MON
4450
```
4551

46-
All three modes share the same scanner, tools, and config. Forms are **never submitted automatically**.
52+
All three options share the same scanner, tools, and config. Forms are **never submitted automatically**.
4753

4854
## Quick Start
4955

50-
### Option A: Docker (recommended — zero setup)
56+
### 1. Docker (recommended — zero setup)
5157

5258
```bash
5359
git clone https://github.com/annawiewer/wiesn-agent.git && cd wiesn-agent
5460
cp config.example.yaml config.yaml # edit with your details
5561
docker compose up # → http://localhost:5000
5662
```
5763

58-
### Option B: Manual
64+
### 2. Manual
5965

6066
```bash
6167
git clone https://github.com/annawiewer/wiesn-agent.git && cd wiesn-agent

0 commit comments

Comments
 (0)