readme-generator
Generates a complete, polished README.md by scanning your actual project structure, dependencies, and code.
by Samuel Rose
About This Skill
Point this skill at any project and it generates a real README from your actual codebase. It scans package.json, pyproject.toml, Cargo.toml, or equivalent to detect your language, framework, and dependencies. It reads your .env.example for setup instructions, checks for Dockerfiles and CI config, and produces a README with only the sections that apply to your project. No placeholder text, no generic filler. Every line is derived from what it actually finds in your repo.
How to Install
unzip readme-generator.zip -d ~/.claude/skills/What This Skill Does
Generates a complete, well-structured README.md by scanning your actual project. It reads your directory structure, package files, configuration, and dependencies to produce a README that includes a project description, installation instructions, usage examples, tech stack overview, and contribution guidelines.
The output reflects what's actually in the repo, not boilerplate. You'll still want to edit it, but you start from an accurate first draft instead of a blank file.
Example Usage
Ask your agent: "Generate a README for this project"
Free
One-time purchase • Own forever
Security Scanned
Passed automated security review
6/8 checks passed
Tags
Frequently Asked Questions
Learn More About AI Agent Skills
Similar Skills
changelog-generator
Generates user-facing changelogs from git history. Transforms developer commit messages into clear release notes that users actually understand.
pr-description-writer
Writes clear pull request descriptions by analyzing your branch diff. Covers what changed, why, how, and what to test. Works with GitHub, GitLab, and Bitbucket.
code-reviewer
Reviews your code for bugs, security vulnerabilities, logic errors, performance issues, and style violations. Organizes findings by severity and suggests fixes with code examples.
env-doctor
Diagnoses why your project will not start. Checks runtime versions, dependencies, environment variables, databases, ports, and build artifacts systematically.