Skip to content

Commit dbbccf8

Browse files
committed
docs: lead README with zero-setup paths
Adds a "Try it with zero setup" section ahead of the cloud quickstart so first-time visitors without an API key see the system-prompt path, the local-model path (Ollama et al), and the brief validator before any paid adapter.
1 parent de7fccf commit dbbccf8

1 file changed

Lines changed: 26 additions & 1 deletion

File tree

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,32 @@ The framework doc and the runtime are the same source of truth. The doc tells th
3535
<em>Phase 0 in one image. What are you shipping today, ops?</em>
3636
</p>
3737

38-
## Quick start (runtime)
38+
## Try it with zero setup
39+
40+
Three ways to use OpenWar without an API key, a paid call, or even Node:
41+
42+
**1. As a system prompt.** Paste [`openwar.md`](./openwar.md) into Claude Code's CLAUDE.md, Cursor's rules, or any agent's system prompt. The framework activates immediately on whatever model that tool already uses.
43+
44+
```bash
45+
curl -fsSL https://raw.githubusercontent.com/pythonluvr/openwar/main/openwar.md >> ~/.claude/CLAUDE.md
46+
```
47+
48+
**2. Against a local model.** If you already run Ollama, llama.cpp, vLLM, or LM Studio:
49+
50+
```bash
51+
npx @pythonluvr/openwar run examples/creative-brief.md \
52+
--adapter openai-compat \
53+
--base-url http://localhost:11434/v1 \
54+
--model llama3.1
55+
```
56+
57+
**3. Just validate a brief.** No model call, just the framework's lint pass:
58+
59+
```bash
60+
npx @pythonluvr/openwar validate examples/multi-agent-brief.md
61+
```
62+
63+
## Quick start (runtime, BYO cloud key)
3964

4065
```bash
4166
npx @pythonluvr/openwar run examples/creative-brief.md --adapter anthropic

0 commit comments

Comments
 (0)