Skip to content

Commit 7d754f8

Browse files
committed
docs: add GitHub alerts and quotes from the lore
- Add [!IMPORTANT], [!NOTE], [!WARNING], [!TIP] alerts - Add opening quote from Shiffman on emergent group dynamics - Add van Merriënboer quote on feedback loops - Add Feathers quote on legacy code - Add closing Evans quote on patterns as building blocks - Strengthen OpenCode-only messaging with proper callouts
1 parent 29332ac commit 7d754f8

1 file changed

Lines changed: 22 additions & 3 deletions

File tree

README.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,16 @@
1414
╚═════╝ ╚═════╝ ╚═╝ ╚═══╝╚═╝ ╚═╝ ╚═════╝
1515
```
1616

17+
> _"These are intelligent and structured group dynamics that emerge not from a leader, but from the local interactions of the elements themselves."_
18+
> — Daniel Shiffman, _The Nature of Code_
19+
1720
**A swarm of agents that learns from its mistakes.**
1821

1922
An [OpenCode](https://opencode.ai) configuration that turns Claude into a multi-agent system. You describe what you want. It decomposes the work, spawns parallel workers, tracks what strategies work, and adapts. Anti-patterns get detected. Proven patterns get promoted. Confidence decays unless revalidated.
2023

2124
Built on [`joelhooks/swarmtools`](https://github.com/joelhooks/swarmtools) - multi-agent orchestration with outcome-based learning.
2225

26+
> [!IMPORTANT]
2327
> **This is an OpenCode config, not a standalone tool.** Everything runs inside OpenCode. The CLIs (`swarm`, `semantic-memory`, `cass`) are backends that agents call - not meant for direct human use.
2428
2529
---
@@ -35,7 +39,8 @@ cd ~/.config/opencode && pnpm install
3539

3640
### 2. Install CLI Tools
3741

38-
These CLIs are backends that OpenCode agents call. You install them, but the agents use them.
42+
> [!NOTE]
43+
> These CLIs are backends that OpenCode agents call. You install them, but the agents use them.
3944
4045
```bash
4146
# Swarm orchestration (required) - agents call this for coordination
@@ -65,8 +70,8 @@ swarm doctor
6570

6671
### 4. Run Your First Swarm
6772

68-
> **IMPORTANT:** All commands run inside [OpenCode](https://opencode.ai), not in your terminal.
69-
> The `swarm` CLI is a backend that OpenCode's agents call - it's not meant for direct human use.
73+
> [!WARNING]
74+
> All commands run **inside [OpenCode](https://opencode.ai)**, not in your terminal. The `swarm` CLI is a backend that agents call - it's not meant for direct human use.
7075
7176
Start OpenCode, then type:
7277

@@ -107,6 +112,9 @@ snyk auth
107112

108113
### The Swarm Learns
109114

115+
> _"Elaborate feedback on errors has repeatedly been found to be more effective than knowledge of results alone."_
116+
> — Jeroen van Merriënboer, _Ten Steps to Complex Learning_
117+
110118
```
111119
┌─────────────────────────────────────────────────────────────────┐
112120
│ LEARNING PIPELINE │
@@ -319,6 +327,9 @@ semantic-memory_find(query="token refresh", expand=true) # Full content
319327

320328
## Skills (On-Demand Knowledge)
321329

330+
> _"Legacy code is simply code without tests."_
331+
> — Michael Feathers, _Working Effectively with Legacy Code_
332+
322333
| Skill | When to Use |
323334
| ---------------------- | ----------------------------------------------------------- |
324335
| **testing-patterns** | Adding tests, breaking dependencies, characterization tests |
@@ -333,6 +344,9 @@ skills_use(name="testing-patterns")
333344
skills_use(name="cli-builder", context="building a new CLI tool")
334345
```
335346

347+
> [!TIP]
348+
> `testing-patterns` includes 25 dependency-breaking techniques from Feathers' _Working Effectively with Legacy Code_. Gold for getting gnarly code under test.
349+
336350
---
337351

338352
## Knowledge Files
@@ -381,3 +395,8 @@ Load via `@knowledge/file-name.md` references when relevant.
381395
## License
382396

383397
MIT
398+
399+
---
400+
401+
> _"One person's pattern can be another person's primitive building block."_
402+
> — Eric Evans, _Domain-Driven Design_

0 commit comments

Comments
 (0)