diff --git a/README.md b/README.md index 952213a..d006644 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,27 @@ -# 🥋 CodeSensei — Learn to Code While You Build +

+ + + + + CodeSensei by Dojo Coding: Learn to code while you build + + +

-[![Claude Code Plugin](https://img.shields.io/badge/Claude_Code-Plugin-blue?logo=anthropic&logoColor=white)](https://github.com/DojoCodingLabs/code-sensei) -[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT) -[![Category: Education](https://img.shields.io/badge/Category-Education-orange)](https://github.com/topics/claude-code-plugin) -[![Free & Open Source](https://img.shields.io/badge/Free-Open_Source-brightgreen)](https://github.com/DojoCodingLabs/code-sensei) +# CodeSensei -### In-context coding tutor for Claude Code — explanations, quizzes, and belt-based progress from your real project +**An in-context coding tutor for Claude Code, for builders who ship with AI and want to understand what they built.** **CodeSensei** is a free, open-source Claude Code plugin by [Dojo Coding](https://dojocoding.io) that turns every coding session into a learning session. It watches what you build locally, explains what just happened in plain language, quizzes you on concepts from your own project, and tracks your growth with a martial arts belt progression system. -

- CodeSensei — Learn to code while you build -

+[![Claude Code Plugin](https://img.shields.io/badge/Claude%20Code-Plugin-201E3D?labelColor=201E3D)](https://github.com/DojoCodingLabs/code-sensei) +[![License: MIT](https://img.shields.io/badge/License-MIT-FF7151?labelColor=201E3D)](https://opensource.org/licenses/MIT) +[![Category: Education](https://img.shields.io/badge/Category-Education-FF7151?labelColor=201E3D)](https://github.com/topics/claude-code-plugin) +[![Free & Open Source](https://img.shields.io/badge/Free-Open%20Source-FF7151?labelColor=201E3D)](https://github.com/DojoCodingLabs/code-sensei) + +[Get started](#quick-start) · [Commands](#commands) · [Privacy](#privacy-and-trust) · [Contribute](CONTRIBUTING.md) · [Report an issue](https://github.com/DojoCodingLabs/code-sensei/issues/new) --- @@ -313,11 +321,8 @@ Learn more: ## License -MIT License. - ---- +MIT License. Built by [Dojo Coding](https://dojocoding.io).

- From vibecoder to engineer — one session at a time.
- Free. Open source. By Dojo Coding. + Dojo Coding

diff --git a/codesenseicover.png b/codesenseicover.png deleted file mode 100644 index ba57883..0000000 Binary files a/codesenseicover.png and /dev/null differ diff --git a/docs/assets/README.md b/docs/assets/README.md new file mode 100644 index 0000000..fdb53a2 --- /dev/null +++ b/docs/assets/README.md @@ -0,0 +1,9 @@ +# Banner + +`banner-light.svg` and `banner-dark.svg` are generated from `banner.toml` with +[dojo-readme-kit](https://github.com/DojoCodingLabs/.github/tree/main/kit), in the +[dojocoding.io](https://dojocoding.io) visual system. To change the banner, edit `banner.toml` and run: + + uvx --from "git+https://github.com/DojoCodingLabs/.github#subdirectory=kit" dojo-banner docs/assets/banner.toml + +`dojocoding-mark.png` is the official Dojo Coding mark, used in the README footer. diff --git a/docs/assets/banner-dark.svg b/docs/assets/banner-dark.svg new file mode 100644 index 0000000..7db37f8 --- /dev/null +++ b/docs/assets/banner-dark.svg @@ -0,0 +1 @@ +CodeSensei by Dojo Coding: Learn to code while you build diff --git a/docs/assets/banner-light.svg b/docs/assets/banner-light.svg new file mode 100644 index 0000000..e5250a1 --- /dev/null +++ b/docs/assets/banner-light.svg @@ -0,0 +1 @@ +CodeSensei by Dojo Coding: Learn to code while you build diff --git a/docs/assets/banner.toml b/docs/assets/banner.toml new file mode 100644 index 0000000..5b52bee --- /dev/null +++ b/docs/assets/banner.toml @@ -0,0 +1,12 @@ +name = "CodeSensei" +tagline = "Learn to code while you [build]" +chips = ["Explain / Quiz / Belts"] +meta = "Open source · Claude Code" +tile = "/" + +[card] +kind = "terminal" +label = "Claude Code" +status = "MIT" +lines = ["/plugin install code-sensei@code-sensei", "/code-sensei:explain", "/code-sensei:quiz"] +dim = "White Belt → Black Belt" diff --git a/docs/assets/dojocoding-mark.png b/docs/assets/dojocoding-mark.png new file mode 100644 index 0000000..02e9446 Binary files /dev/null and b/docs/assets/dojocoding-mark.png differ