Skip to content

Commit 9ee9741

Browse files
auge2uclaude
andcommitted
docs: improve README with better structure and documentation links
- Add sections for Claude Code and non-Claude installation - Link components to skill files in this repo - Add documentation section with all guides - Add requirements section - Add updating section 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 6496ec4 commit 9ee9741

1 file changed

Lines changed: 53 additions & 20 deletions

File tree

README.md

Lines changed: 53 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,28 @@ A comprehensive, Claude-native developer environment toolkit.
66

77
## Quick Start
88

9-
```
9+
### With Claude Code
10+
11+
```bash
1012
# In Claude Code, simply say:
1113
"Set up my dev environment for Claude"
1214

1315
# Or invoke the skill directly:
1416
Skill: setup-claude-dev-kit
1517
```
1618

19+
### Without Claude Code
20+
21+
```bash
22+
# One-liner installation
23+
curl -fsSL https://raw.githubusercontent.com/claude-dev-kit/claude-dev-kit/main/install.sh | bash
24+
25+
# Or clone and run
26+
git clone https://github.com/claude-dev-kit/claude-dev-kit.git
27+
cd claude-dev-kit
28+
./install.sh
29+
```
30+
1731
## Bundles
1832

1933
| Bundle | Components | Use Case |
@@ -24,14 +38,14 @@ Skill: setup-claude-dev-kit
2438

2539
## Components
2640

27-
| Component | Description |
28-
|-----------|-------------|
29-
| [cdk-shell](https://github.com/claude-dev-kit/cdk-shell) | Zsh, Powerlevel10k, completions, aliases |
30-
| [cdk-editor](https://github.com/claude-dev-kit/cdk-editor) | VS Code/Cursor settings, extensions |
31-
| [cdk-git](https://github.com/claude-dev-kit/cdk-git) | Hooks, commit templates, PR workflows |
32-
| [cdk-templates](https://github.com/claude-dev-kit/cdk-templates) | CLAUDE.md templates, project scaffolds |
33-
| [cdk-quality](https://github.com/claude-dev-kit/cdk-quality) | Linting, testing, review automation |
34-
| [cdk-memory](https://github.com/claude-dev-kit/cdk-memory) | Context/conversation management |
41+
| Component | Skill | Description |
42+
|-----------|-------|-------------|
43+
| Shell | [`setup-cdk-shell`](skills/shell/SKILL.md) | Zsh, Powerlevel10k, completions, aliases |
44+
| Editor | [`setup-cdk-editor`](skills/editor/SKILL.md) | VS Code/Cursor settings, extensions |
45+
| Git | [`setup-cdk-git`](skills/git/SKILL.md) | Hooks, commit templates, PR workflows |
46+
| Templates | [`setup-cdk-templates`](skills/templates/SKILL.md) | CLAUDE.md templates, project scaffolds |
47+
| Quality | [`setup-cdk-quality`](skills/quality/SKILL.md) | Linting, CI workflows, review automation |
48+
| Memory | [`setup-cdk-memory`](skills/memory/SKILL.md) | Context management, session export |
3549

3650
## Installation Modes
3751

@@ -41,27 +55,46 @@ Opinionated defaults, fast setup, minimal questions.
4155
### Adaptation (Existing Setup)
4256
Respects your config, shows diffs, backs up before changes.
4357

44-
## Manual Installation
45-
46-
If you prefer not to use Claude Code:
58+
## Install Script Options
4759

4860
```bash
49-
# Interactive installation
50-
curl -fsSL https://raw.githubusercontent.com/claude-dev-kit/claude-dev-kit/main/install.sh | bash
51-
52-
# Or with options
53-
./install.sh --bundle standard # Skip prompts, use standard bundle
54-
./install.sh --bundle minimal --non-interactive # Fully automated
61+
./install.sh [options]
5562
```
5663

57-
### Options
58-
5964
| Flag | Description |
6065
|------|-------------|
6166
| `--bundle <name>` | Choose bundle: minimal, standard, full |
6267
| `--non-interactive` | Skip all prompts, use defaults |
6368
| `--help` | Show help |
6469

70+
## Updating
71+
72+
```bash
73+
# With Claude Code
74+
claude "update-claude-dev-kit"
75+
76+
# Or re-run install script (safe to run multiple times)
77+
./install.sh
78+
```
79+
80+
## Documentation
81+
82+
- [Skills Reference](skills/README.md) - All available skills
83+
- [Testing Guide](docs/TESTING.md) - How to test components
84+
- [Troubleshooting](docs/TROUBLESHOOTING.md) - Common issues and fixes
85+
- [Contributing](CONTRIBUTING.md) - How to contribute
86+
- [Changelog](CHANGELOG.md) - Version history
87+
88+
## Requirements
89+
90+
- macOS 12+ or Ubuntu 22.04+
91+
- git
92+
- curl
93+
94+
Optional:
95+
- [Claude Code](https://claude.ai/code) - For the full interactive experience
96+
- VS Code or Cursor - For editor component
97+
6598
## License
6699

67100
MIT

0 commit comments

Comments
 (0)