From mblode-agent-skills
Writes or rewrites README.md files tailored to the project type (CLI, library, app, framework, monorepo, or skill bundle). Discovers project context, selects the right structure, writes section by section, and validates against quality checks. Use when creating a README, writing a README from scratch, rewriting a bad README, bootstrapping project documentation, or asking "write a README for this project."
npx claudepluginhub joshuarweaver/cascade-code-general-misc-4 --plugin mblode-agent-skillsThis skill uses the workspace's default tool permissions.
Write or rewrite a README.md tailored to the project type and audience.
Guides Next.js Cache Components and Partial Prerendering (PPR) with cacheComponents enabled. Implements 'use cache', cacheLife(), cacheTag(), revalidateTag(), static/dynamic optimization, and cache debugging.
Guides building MCP servers enabling LLMs to interact with external services via tools. Covers best practices, TypeScript/Node (MCP SDK), Python (FastMCP).
Generates original PNG/PDF visual art via design philosophy manifestos for posters, graphics, and static designs on user request.
Write or rewrite a README.md tailored to the project type and audience.
| File | Read When |
|---|---|
references/section-templates.md | Phase 3: choosing structure and writing sections for a specific project type |
references/quality-checklist.md | Phase 5: validating the finished README against quality standards |
references/badges-and-shields.md | Phase 4: adding badges after the main content is written |
Copy this checklist to track progress:
README progress:
- [ ] Phase 1: Discover project context
- [ ] Phase 2: Choose README structure
- [ ] Phase 3: Write sections
- [ ] Phase 4: Add badges and extras
- [ ] Phase 5: Validate quality
Read the project before asking questions. Explore files to detect the project type:
package.json, Cargo.toml, pyproject.toml, go.mod, or equivalent for name, description, license, dependencies, scripts, and bin field.Classify into one of six project types:
| Type | Signals |
|---|---|
| CLI tool | bin field in package.json, src/cli.ts, commander/yargs dependency |
| Library / package | main/exports in package.json, no bin field, src/index.ts |
| Web app | next.config.ts, vite.config.ts, framework dependency, no npm publish |
| Framework | Plugin/middleware architecture, configuration API, extensibility points |
| Monorepo | turbo.json, pnpm-workspace.yaml, apps/ + packages/ directories |
| Skill bundle | skills/ directory with SKILL.md files |
Ask the user only for what cannot be discovered from the code:
Load references/section-templates.md.
Select sections based on the project type:
| Section | CLI | Library | App | Framework | Monorepo | Skills |
|---|---|---|---|---|---|---|
| Title + one-liner | yes | yes | yes | yes | yes | yes |
| Badges | yes | yes | -- | yes | yes | -- |
| Features / highlights | yes | yes | yes | yes | -- | yes |
| Install | yes | yes | -- | yes | yes | -- |
| Quick start / usage | yes | yes | yes | yes | yes | yes |
| Options / API reference | yes | yes | -- | yes | -- | -- |
| Configuration | opt | opt | yes | yes | opt | -- |
| Environment variables | -- | -- | yes | -- | -- | -- |
| Packages table | -- | -- | -- | -- | yes | -- |
| Skills table | -- | -- | -- | -- | -- | yes |
| Requirements | yes | yes | opt | yes | opt | -- |
| Contributing | opt | opt | opt | opt | opt | opt |
| License | yes | yes | yes | yes | yes | opt |
Load references/section-templates.md. Write each section following the template for the detected project type.
Key principles:
npm install -g for CLIs, npm install for libraries.foo or example.Load references/badges-and-shields.md. Add badges only if the project is published to a registry. Place directly below the title and one-liner. Maximum 4 badges.
Skip badges entirely for private apps, unpublished projects, and skill bundles.
Load references/quality-checklist.md. Run through every applicable check. Fix issues before finalizing.
After fixes, reread the README top to bottom to confirm it flows naturally.
foo, bar, or test as example values| When | Run |
|---|---|
| After README is written, audit prose quality | docs-writing |
| If project needs AGENTS.md / CLAUDE.md | agents-md |