github--spec-kit/extensions/template/EXAMPLE-README.md

EXAMPLE: Extension README

This is an example of what your extension README should look like after customization. Delete this file and replace README.md with content similar to this.

---

My Extension

Brief description of what your extension does and why it's useful.

Features

• Feature 1: Description
• Feature 2: Description
• Feature 3: Description

Installation

# Install from catalog
specify extension add my-extension

# Or install from local development directory
specify extension add --dev /path/to/my-extension

Configuration

1. Create configuration file:

   cp .specify/extensions/my-extension/config-template.yml \
      .specify/extensions/my-extension/my-extension-config.yml
   

2. Edit configuration:

   vim .specify/extensions/my-extension/my-extension-config.yml
   

3. Set required values:

   connection:
     url: "https://api.example.com"
     api_key: "your-api-key"
   
   project:
     id: "your-project-id"
   

Usage

Command: example

Description of what this command does.

# In Claude Code
> /speckit.my-extension.example

Prerequisites:

• Prerequisite 1
• Prerequisite 2

Output:

• What this command produces
• Where results are saved

Configuration Reference

Connection Settings

Setting	Type	Required	Description
connection.url	string	Yes	API endpoint URL
connection.api_key	string	Yes	API authentication key

Project Settings

Setting	Type	Required	Description
project.id	string	Yes	Project identifier
project.workspace	string	No	Workspace or organization

Environment Variables

Override configuration with environment variables:

# Override connection settings
export SPECKIT_MY_EXTENSION_CONNECTION_URL="https://custom-api.com"
export SPECKIT_MY_EXTENSION_CONNECTION_API_KEY="custom-key"

Examples

Example 1: Basic Workflow

# Step 1: Create specification
> /speckit.spec

# Step 2: Generate tasks
> /speckit.tasks

# Step 3: Use extension
> /speckit.my-extension.example

Troubleshooting

Issue: Configuration not found

Solution: Create config from template (see Configuration section)

Issue: Command not available

Solutions:

1. Check extension is installed: specify extension list
2. Restart AI agent
3. Reinstall extension

License

MIT License - see LICENSE file

Support

• Issues: https://github.com/your-org/spec-kit-my-extension/issues
• Spec Kit Docs: https://github.com/statsperform/spec-kit

Changelog

See CHANGELOG.md for version history.

---

Extension Version: 1.0.0 Spec Kit: >=0.1.0