ccstart 2.1.0 → 3.0.0

package/README.md

@@ -5,57 +5,54 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![npm downloads](https://img.shields.io/npm/dm/ccstart.svg)](https://www.npmjs.com/package/ccstart)
 
-Quick setup for Claude Code projects with built-in agents, ticket system, planning tools and agent orchestration workflow.
+Quick setup for Claude Code projects with built-in agents, skills, and tickets.
 
 ## Installation
 
 ```bash
-# Create a new project
-npx ccstart my-project
+# To set up in a specific directory
+npx ccstart <project directory>
 
 # Setup in current directory
 npx ccstart .
 
 # Install globally (optional)
 npm install -g ccstart
-ccstart my-project
+ccstart <project directory>
 ```
 
-## What's Included
-
-- **CLAUDE.md** - Project instructions for Claude (references claude/ subdirectories)
-- **claude/** - All Claude-related files in one organized directory:
-  - **agents/** - 8 specialized AI agents (planner, coder, checker, researcher, etc.)
-  - **tickets/** - Task tracking system with ticket templates
-  - **plans/** - Project planning documents
-  - **docs/** - ROADMAP.md and agent orchestration workflows
-- **.claude/** - Claude Code configuration (created automatically):
-  - **agents/** - Selected agents for Claude Code integration
-  - **commands/** - Custom slash commands including `/update-claude-md`
-  - **hooks/** - Automatic workflow detection
-  - **settings.json.example** - Hook configuration
-
-## Key Features
-
-- 🎯 **Interactive Agent Selection** - Choose which agents to include during setup
-- 🔄 **Agent Orchestration Workflows** - Pre-defined workflows that coordinate multiple agents
-- 🔒 **Smart Conflict Resolution** - Handle existing files with skip/rename/overwrite options
-- 📁 **Auto-detects Claude Code** - Creates .claude directory structure automatically
-- 🏃 **Dry Run Mode** - Preview changes before applying them
-- ⚡ **Force Mode** - Skip all prompts for automated workflows
-- 🎭 **Workflow Commands** - Execute complex workflows with single commands
-- 🪝 **Intelligent Hooks** - Automatically detect task patterns and suggest workflows
-
-## Quick Start
-
-```bash
-npx ccstart my-project
-cd my-project
+## What You Get
 
-# Edit CLAUDE.md with your project details
-# Start using Claude Code with pre-configured agents and workflows
+```
+my-project/
+├── CLAUDE.md                 # Project instructions for Claude
+├── claude/
+│   └── tickets/              # Task tracking system
+└── .claude/
+    ├── agents/               # Agents for Claude Code integration
+    ├── skills/               # Skills for Claude Code integration
+    └── hooks/                # Hooks for Claude Code integration
 ```
 
+## The Workflow
+
+### How Claude Uses Your Project
+
+1. **CLAUDE.md** provides context and instructions
+2. **Agents** handle specialized tasks:
+   - `planner` - Strategic planning and task breakdown
+   - `checker` - Quality assurance and code review
+   - `backend` - Backend architecture and API design
+   - `frontend` - Frontend architecture and UI design
+3. **Skills** automate common workflows:
+   - `/commit` - Conventional commits
+   - `/create-pr` - Structured pull requests
+   - `/create-ticket` - Task ticket creation
+   - `/design-feature` - Feature design phases
+   - `/skill-creator` - Create new skills
+   - `/update-claude-md` - Update CLAUDE.md sections
+4. **Tickets** track tasks with status emojis
+
 ## Command Line Options
 
 ```bash
@@ -75,33 +72,61 @@ Examples:
   ccstart --agents             # Preview available agents
 ```
 
-## Agent Orchestration
+## Interactive Setup
 
-The template includes pre-configured workflows that automatically coordinate agents:
+When you run `ccstart`, you'll be guided through three selection prompts:
 
-- **Feature Development** → Researcher → Planner → Coder → Checker
-- **Bug Fix** → Researcher → Coder → Checker
-- **API Development** → Planner → Backend → Frontend → Checker
-- **Refactoring** → Researcher → Planner → Coder → Checker
-- **UI Components** → Frontend → Shadcn → Checker
-- **Quality Assurance** → Researcher → Checker → Coder → Checker
+### Agent Selection
 
-See `claude/docs/agent-orchestration.md` for detailed workflow documentation.
+```
+? Choose your agents: (Press <space> to select, <a> to toggle all)
+❯◯ planner
+     Strategic planning and task breakdown specialist
+ ◯ checker
+     Quality assurance and code review specialist
+ ◯ backend
+     Backend architecture and API design specialist
+ ◯ frontend
+     Frontend architecture and UI design specialist
+```
+
+### Skill Selection
+
+```
+? Choose your skills: (Press <space> to select, <a> to toggle all)
+❯◯ commit
+     Generate and execute git commits following conventional commit format
+ ◯ create-pr
+     Create GitHub pull requests with properly structured descriptions
+ ◯ create-ticket
+     Create task tickets with proper numbering and update ticket-list.md
+ ◯ design-feature
+     Guide feature development through requirements and design phases
+ ◯ skill-creator
+     Guide for creating new skills
+ ◯ update-claude-md
+     Update CLAUDE.md sections through interactive Q&A
+```
+
+Use `--all-agents` to skip agent selection and include all agents.
 
-## Custom Commands & Hooks
+## Key Features
 
-### Slash Commands
-- `/update-claude-md` - Automatically populate project information in CLAUDE.md
-- `/workflow-*` commands - Execute orchestrated workflows (coming soon)
+- **Interactive Agent & Skill Selection** - Choose which agents and skills to include during setup
+- **Smart Conflict Resolution** - Handle existing files with skip/rename/overwrite options
+- **Auto-detects Claude Code** - Creates .claude directory structure automatically
+- **Dry Run Mode** - Preview changes before applying them
+- **Force Mode** - Skip all prompts for automated workflows
 
-### Automatic Workflow Detection
-Hooks automatically detect task patterns and suggest appropriate workflows:
-- Feature requests → suggests `/workflow-feature`
-- Bug reports → suggests `/workflow-bug`
-- API tasks → suggests `/workflow-api`
-- And more! (QA, refactoring, UI components, blockchain)
+## Quick Start
 
-Hooks are automatically enabled - no setup required!
+```bash
+npx ccstart my-project
+cd my-project
+
+# Edit CLAUDE.md with your project details
+# Start using Claude Code with pre-configured agents and workflows
+```
 
 ## Local Development
 
@@ -120,8 +145,8 @@ npm unlink -g ccstart
 
 ## Credits
 
-Born from our discussions in TechOverflow with [vichannnnn](https://github.com/vichannnnn), [MrMarciaOng](https://github.com/MrMarciaOng), and [nasdin](https://github.com/nasdin)
+Born from our discussions in TechOverflow with [vichannnnn](https://github.com/vichannnnn) and [MrMarciaOng](https://github.com/MrMarciaOng).
 
 ## License
 
-MIT
+MIT