mblode avatar

Readme Creator

Generates project READMEs that match your project type instead of cargo culting templates. It reads your package.json or equivalent, checks your directory structure, figures out if you're shipping a CLI, library, app, framework, or monorepo, then writes appropriate sections in order. The workflow is phased: discover context, pick structure, write sections, add badges if published, validate against a quality checklist. It knows to put features above the fold, keep install instructions to one command, and make examples copy-pasteable. Useful when you're staring at a blank README or inheriting a project with the default Vite boilerplate still in it.

skills.sh installs
604
GitHub stars
191
last updated
Aug 21, 2026

Install

$ npx -y skills add mblode/agent-skills --skill readme-creator --agent claude-code

Installs into .claude/skills of the current project.

Files

Generates project READMEs that match your project type instead of cargo culting templates. It reads your package.json or equivalent, checks your directory structure, figures out if you're shipping a CLI, library, app, framework, or monorepo, then writes appropriate sections in order. The workflow is phased: discover context, pick structure, write sections, add badges if published, validate against a quality checklist. It knows to put features above the fold, keep install instructions to one command, and make examples copy-pasteable. Useful when you're staring at a blank README or inheriting a project with the default Vite boilerplate still in it.

Browse the repository on GitHub

Sponsors

Details

Repository
github.com/mblode/agent-skills
Categories
Documentation, Code Review & Quality, AI & Agent Building, CLI & Terminal
First seen
Jun 3, 2026

More from mblode/agent-skills

All 22
1moizibnyousaf avatarcode-documentationmoizibnyousaf/ai-agent-skillsWriting effective code documentation - API docs, README files, inline comments, and technical guides. Use for documenting codebases, APIs, or writing developer 569skills.sh installs
2aj-geddes avatarcode-documentationaj-geddes/useful-ai-promptsWrite comprehensive code documentation including JSDoc, Python docstrings, inline comments, function documentation, and API comments. Use when documenting code,500skills.sh installs
3tldraw avatarwrite-docstldraw/tldrawWriting SDK documentation for tldraw. Use when creating new documentation articles, updating existing docs, or when documentation writing guidance is needed. Ap491skills.sh installs
4mblode avatarblog-postmblode/agent-skillsGenerates engaging long-form blog posts from source materials or a topic brief. Supports listicles, editorial tutorials, how-to articles, narrative essays, and 404skills.sh installs
5tldraw avatarreview-docstldraw/tldrawReview and improve tldraw SDK documentation against the voice and docs guides, scoring each article and iterating until it passes. Use when asked to review docs397skills.sh installs
6levnikolaevich avatarln-140-test-docs-creatorlevnikolaevich/claude-code-skillsCreates test documentation (testing-strategy.md, tests/README.md) with Risk-Based Testing philosophy. Use when setting up test strategy for a project.394skills.sh installs