@@ -54,10 +54,11 @@ OpenSpec turns specifications into living documentation that drives development.
5454
5555### Install OpenSpec
5656
57- - Global: ` npm install -g @fission-ai/openspec `
58- - Local (per project):
59- - ` npm install --save-dev @fission-ai/openspec `
60- - Run with ` npx openspec ... `
57+ Install globally:
58+
59+ ``` bash
60+ npm install -g @fission-ai/openspec
61+ ```
6162
6263## Getting Started
6364
@@ -74,8 +75,6 @@ openspec init
7475# "Which AI tool do you use?"
7576# > Claude Code
7677# Cursor (coming soon)
77- # Aider (coming soon)
78- # Continue (coming soon)
7978
8079# This creates:
8180# openspec/
@@ -84,25 +83,32 @@ openspec init
8483# └── README.md # AI instructions
8584```
8685
87- ### 2. Start Working with Your AI Assistant
86+ ### 2. Create Your First Change Proposal
8887
89- After initialization, copy these prompts to your AI assistant (Claude Code, Cursor, etc.):
88+ After initialization, tell your AI assistant (Claude Code, Cursor, etc.):
9089
9190``` markdown
92- // First, establish project context:
93- "Please read openspec/project.md and help me fill it out
94- with details about my project, tech stack, and conventions"
95-
96- // Then create your first change proposal:
91+ // Step 1: Create the change proposal
9792"I want to add user authentication with JWT tokens.
9893Please create an OpenSpec change proposal for this feature"
9994
10095// Your AI will:
10196// 1. Create openspec/changes/add-user-auth/
102- // 2. Write proposal.md explaining why and what
103- // 3. Create tasks .md with implementation steps
97+ // 2. Write proposal.md explaining why and what
98+ // 3. Create design .md with technical decisions (optional)
10499// 4. Generate spec deltas showing what's being added
105- // 5. Implement the code following the tasks
100+ // 5. Create tasks.md with implementation checklist
101+
102+ // Step 2: Review the proposal
103+ // Look at the generated files and ensure they match your vision
104+ // Make any adjustments needed to the proposal or specs
105+
106+ // Step 3: When ready, implement the change
107+ "The proposal looks good. Let's implement the user authentication
108+ change following the tasks in openspec/changes/add-user-auth/tasks.md"
109+
110+ // AI will then work through each task systematically,
111+ // marking them complete as it implements the feature
106112```
107113
108114### 3. AI-Driven Development Workflow
0 commit comments