Readme Generator
by Samuel Rose
Generates a complete, polished README.md by scanning your actual project structure, dependencies, and code.
Free
Works with the AI tools you already use
See it in action
You say
Scan my repository and generate a README.md that includes the project structure, setup steps from my config files, and a specific description of what the code actually does.
Your agent does
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.
How to install
Drop the file into your AI Agent. Works with Claude, Cursor, ChatGPT, and 20+ more.
Reviews
No reviews yet
Be one of the first to try it. Every listed skill passes our trust checks below.
Security scanned
Passed our 8-point scan before listing
197 installs
Downloaded by developers to date
Free forever
No account required to browse
Trust & safety
Security scanned
Verified clean 4 months ago
- Free forever, no account required
Frequently Asked Questions
Popular in Documentation
Git Writing Suite
Turn your diffs and commit history into commit messages, PR descriptions, and release notes that reviewers and users actually read. One skill, three jobs — conventional-commit compliant, reviewer-ready, and written in plain language.
API Docs Writer
Generate consistent API reference docs from your code, OpenAPI spec, or route handlers — per-endpoint parameters, real request and response examples, error codes, auth, and copy-pasteable curl, written for the developer calling the API.
README Quick Check
A fast READY or NEEDS WORK check for your README. Catches the make-or-break gaps — missing what-and-why, setup, or a working example — in about 30 seconds.
skill-polisher
Transform raw skill documentation into high-conversion, readable marketplace listings without losing LLM context.