Skip to content

Commit e675418

Browse files
Juan C. Guerrerowarp-agent
authored andcommitted
Fix README: install syntax, jq dependency, plugin structure, command prefixes
- Use @marketplace-name install pattern per official Claude Code docs - Add jq dependency note (required by hook scripts) - Add 'What's Included' section showing full plugin structure - Fix command references in How It Works (add code-sensei: prefix) - Match GitHub org casing to actual DojoCodingLabs Co-Authored-By: Warp <agent@warp.dev>
1 parent 08180a8 commit e675418

File tree

3 files changed

+35
-7
lines changed

3 files changed

+35
-7
lines changed

β€Ž.claude-plugin/plugin.jsonβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"url": "https://dojocoding.io"
88
},
99
"homepage": "https://dojocoding.io/code-sensei",
10-
"repository": "https://github.com/dojocodinglabs/code-sensei",
10+
"repository": "https://github.com/DojoCodingLabs/code-sensei",
1111
"license": "MIT",
1212
"keywords": [
1313
"learning",

β€ŽCONTRIBUTING.mdβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Priority languages: Spanish (es), Portuguese (pt), French (fr), Japanese (ja), K
4040

4141
### Setup
4242
```bash
43-
git clone https://github.com/dojocodinglabs/code-sensei.git
43+
git clone https://github.com/DojoCodingLabs/code-sensei.git
4444
cd code-sensei
4545
```
4646

β€ŽREADME.mdβ€Ž

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,16 +58,18 @@ Every explanation, every quiz, every session earns XP. Every belt promotion is a
5858

5959
```bash
6060
# In Claude Code:
61-
/plugin marketplace add dojocodinglabs/code-sensei
62-
/plugin install code-sensei
61+
/plugin marketplace add DojoCodingLabs/code-sensei
62+
/plugin install code-sensei@code-sensei
6363
```
6464

65-
That's it. Restart Claude Code and start building. CodeSensei is ready.
65+
That's it. Start building β€” CodeSensei activates automatically.
66+
67+
> **Requires:** [Claude Code](https://code.claude.com) with plugin support. Hook scripts use `jq` for profile tracking β€” install with `brew install jq` (macOS) or `apt install jq` (Linux).
6668
6769
### Local Development
6870

6971
```bash
70-
git clone https://github.com/dojocodinglabs/code-sensei.git
72+
git clone https://github.com/DojoCodingLabs/code-sensei.git
7173
cd code-sensei
7274

7375
# In Claude Code:
@@ -95,7 +97,7 @@ cd code-sensei
9597

9698
1. **You vibecode normally** β€” prompt Claude to build whatever you want
9799
2. **Hooks track what happens** β€” file changes, commands run, technologies used
98-
3. **You ask when curious** β€” `/explain`, `/quiz`, `/why` whenever you want to learn
100+
3. **You ask when curious** β€” `/code-sensei:explain`, `/code-sensei:quiz`, `/code-sensei:why` whenever you want to learn
99101
4. **CodeSensei adapts** β€” explanations match your belt level and background
100102
5. **You level up** β€” XP accumulates, belts are earned, skills unlock
101103
6. **Progress persists** β€” your profile lives at `~/.code-sensei/` and works across all projects
@@ -131,6 +133,32 @@ Everything stays on your machine in `~/.code-sensei/`.
131133

132134
---
133135

136+
## πŸ”§ What's Included
137+
138+
```
139+
code-sensei/
140+
β”œβ”€β”€ .claude-plugin/
141+
β”‚ β”œβ”€β”€ plugin.json # Plugin metadata
142+
β”‚ └── marketplace.json # Marketplace catalog
143+
β”œβ”€β”€ commands/ # 7 slash commands
144+
β”‚ β”œβ”€β”€ explain.md # /code-sensei:explain
145+
β”‚ β”œβ”€β”€ quiz.md # /code-sensei:quiz
146+
β”‚ β”œβ”€β”€ why.md # /code-sensei:why
147+
β”‚ β”œβ”€β”€ progress.md # /code-sensei:progress
148+
β”‚ β”œβ”€β”€ recap.md # /code-sensei:recap
149+
β”‚ β”œβ”€β”€ level.md # /code-sensei:level
150+
β”‚ └── belt.md # /code-sensei:belt
151+
β”œβ”€β”€ agents/
152+
β”‚ └── sensei.md # AI mentor subagent (Haiku)
153+
β”œβ”€β”€ skills/ # 10 auto-invoked teaching modules
154+
β”œβ”€β”€ hooks/
155+
β”‚ └── hooks.json # Session & code change tracking
156+
β”œβ”€β”€ scripts/ # Hook scripts (bash + jq)
157+
└── data/ # Concept tree & quiz bank
158+
```
159+
160+
---
161+
134162
## πŸ“š Learning Modules
135163

136164
CodeSensei covers **42 concepts** across **9 categories**:

0 commit comments

Comments
Β (0)