Skip to content

Commit 792129b

Browse files
committed
docs(readme): highlight supported AI tools and emphasize universal interoperability
1 parent 715ff51 commit 792129b

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@
66
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)
77
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
88

9-
AI-native system for spec-driven development. Keep living specifications alongside code, propose changes as deltas, and archive once reality matches the spec.
9+
**Supported AI Tools:** ✅ Claude Code | 🔜 Cursor (coming soon) | 🔜 AGENTS.md support (coming soon)
10+
11+
Universal spec-driven development that works with your AI coding assistant. Keep living specifications alongside code, propose changes as deltas, and archive once reality matches the spec. **No API keys required.**
1012

1113
OpenSpec turns specifications into living documentation that drives development. Your specs and code stay in sync—propose changes, track implementation, and know exactly when features are complete. No more outdated docs or unclear requirements.
1214

@@ -24,10 +26,11 @@ OpenSpec turns specifications into living documentation that drives development.
2426
## What You Get
2527

2628
- **Better AI Code Generation** - Create specs first, get the code you actually want
29+
- **Universal Tool Support** - Works with any AI assistant - Claude Code, Cursor, or future tools
30+
- **No API Keys Required** - Integrates through context rules, not external services
2731
- **Alignment with AI** - Your AI assistant understands exactly what to build through clear specifications
2832
- **Plan Before You Build** - Clarify features and requirements before implementation
2933
- **Team Clarity** - Everyone reviews specs, not code changes
30-
- **No API Keys** - Works with your existing AI tools (Claude Code, Cursor) by adding context rules
3134
- **Track Progress** - See what changes are proposed, in progress, or completed
3235

3336
## How It Works
@@ -74,7 +77,7 @@ cd my-project
7477
# Initialize OpenSpec
7578
openspec init
7679

77-
# You'll be asked:
80+
# Select your AI tool (more coming soon!):
7881
# "Which AI tool do you use?"
7982
# > Claude Code
8083
# Cursor (coming soon)
@@ -83,12 +86,12 @@ openspec init
8386
# openspec/
8487
# ├── specs/ # Current specifications (truth)
8588
# ├── changes/ # Proposed changes
86-
# └── README.md # AI instructions
89+
# └── README.md # AI instructions for your tool
8790
```
8891

8992
### 2. Create Your First Change
9093

91-
Jump straight into creating a change proposal with your AI assistant:
94+
Jump straight into creating a change proposal with your AI assistant (works with Claude Code, Cursor, or any AI tool):
9295

9396
```markdown
9497
// Quick win - Add a simple new feature:
@@ -234,7 +237,7 @@ OpenSpec creates **alignment** between you and your AI coding assistant:
234237
4. **AI implements** exactly what was specified
235238
5. **Everyone understands** what's being built through clear specs
236239

237-
No API keys needed - OpenSpec works by adding context rules to your existing AI tools (Claude Code, Cursor, etc.).
240+
**True Interoperability:** OpenSpec is designed to be universal. No API keys, no vendor lock-in. It works by adding context rules to ANY AI coding tool - whether you use Claude Code today, switch to Cursor tomorrow, or adopt the next breakthrough AI assistant. Your specs remain portable and your workflow stays consistent.
238241

239242

240243
## How OpenSpec Compares
@@ -254,7 +257,7 @@ Without specs, AI coding assistants generate code based on vague prompts, often
254257
3. **Build incrementally** - Each new feature adds to your spec library
255258
4. **Future capability** - We're working on tools to generate specs from existing code
256259

257-
`openspec update` is team-friendly: it updates instruction files without forcing tools on teammates. Multiple AI assistants can coexist without conflicts.
260+
**Tool Freedom:** Your team can use different AI assistants. One developer might use Claude Code while another uses Cursor - OpenSpec keeps everyone aligned through shared specifications. Run `openspec update` to configure for any supported tool without affecting others.
258261

259262

260263
## Contributing

0 commit comments

Comments
 (0)