readme-generator
by Samuel Rose
Generates a complete, polished README.md by scanning your actual project structure, dependencies, and code.
- Scaffold setup guides directly from environment variables and config files
- Document project dependencies automatically by scanning manifest files
- Draft tailored installation steps based on detected package managers
Free
One-time purchase · Own forever
Included in download
- Downloadable skill package
- Works with Claude Code, Cursor
- 2 permissions declared
See it in action
A professional README.md featuring a project-specific 'About' section, precise install commands derived from your package manager, a visual directory structure, and environment variable setup instructions—all without generic 'TODO' placeholders.
readme-generator
by Samuel Rose
Generates a complete, polished README.md by scanning your actual project structure, dependencies, and code.
Free
One-time purchase · Own forever
⚡ Also available via Agensi MCP — your AI agent can load this skill on demand via MCP. Learn more →
Included in download
- Downloadable skill package
- Works with Claude Code, Cursor
- 2 permissions declared
- Instant install
See it in action
A professional README.md featuring a project-specific 'About' section, precise install commands derived from your package manager, a visual directory structure, and environment variable setup instructions—all without generic 'TODO' placeholders.
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.
Use Cases
- Scaffold setup guides directly from environment variables and config files
- Document project dependencies automatically by scanning manifest files
- Draft tailored installation steps based on detected package managers
- Outline project structure by mapping the actual directory tree
- Identify prerequisite tools from Dockerfiles and CI configuration files
Known Limitations
- Visual assets (images/logos) are not generated. - Accuracy depends on code readability and existing file naming conventions. - Deep architectural logic may be missed in obfuscated code.
How to Install
unzip readme-generator.zip -d ~/.claude/skills/Reviews
No reviews yet — be the first to share your experience.
Only users who have downloaded or purchased this skill can leave a review.
No reviews yet — be the first to share your experience.
Only users who have downloaded or purchased this skill can leave a review.
Security Scanned
Passed automated security review
Permissions
Allowed Hosts
Claude Code, Cursor, Windsurf, and other agents that support SKILL.md-style workflows and local file system access.
Frequently Asked Questions
Learn More About AI Agent Skills
Similar Skills
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.
changelog-generator
Generates user-facing changelogs from git history. Transforms developer commit messages into clear release notes that users actually understand.
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.
git-commit-writer
Writes conventional commit messages by analyzing your staged git changes. Detects commit type, scope, and breaking changes automatically.