- Home
- Skills
- Technical Documentation
- π README Generator
More screenshots
Works with the AI Agents you already use
π README Generator
It extracts real scripts, validates entry points, and maps dependencies to generate accurate installation and usage guides.
Free
π README Generator
Example session with this skill installed
Review my node.js project and generate a README with badges, installation steps, scripts from package.json, and a list of dependencies.
- Read your context and instructions
- Compiled the readme generator
Project Name
Installation
npm install
Scripts
npm start: Runs src/index.tsnpm test: Runs jest
Dependencies
- express ^4.18.2
- typescript ^5.0.0
TODO: Add environment variables for API_KEY.
Connects securely to your tools. The creator never sees your data.
About this skill
Professional READMEs from Reality, Not Hallucinations
Stop manually formatting documentation and wrestling with template headers. This skill automates the creation of polished, production-ready README files by deep-scanning your repository's actual structure and configuration files.
What it does
Unlike generic AI prompts that guess how your code works, this skill performs an environmental audit. It identifies your tech stack by inspecting manifests like package.json, pyproject.toml, go.mod, and Cargo.toml. It extracts real scripts, validates entry points, and maps dependencies to generate accurate installation and usage guides.
Key Features
- Multi-Language Support: Tailored documentation for Node/TypeScript, Python, Go, Rust, and Java environments.
- Safe Inspection: Uses
--helpflags and manifest parsing to find commands without modifying your code. - Evidence-Based: Extract descriptions from docstrings and JSDocs rather than inventing project goals.
- Dynamic Badges: Automatically includes license, version, and language badges based on detected metadata.
Why use this skill?
It eliminates "documentation drift." By grounding the output in your source code's reality, it ensures that if a script isn't in your manifest, it isn't in your README. It provides a standardized, professional structure that makes any repo "onboarding-ready" in seconds.
- Writes or updates README.md in the project root unless you request another path; review the generated diff before committing.
- Generates Markdown only (no PDF or HTML export).
- Some badge URLs are placeholders and need project-specific values.
- API documentation depends on existing JSDoc or docstrings.
- Leaves TODOs when repository evidence is missing instead of inventing commands or configuration.
- Does not commit or push changes.
How to use
- 1
Connect your agent to the Agensi MCP
Copy the prompt and paste it into Claude, ChatGPT, Cursor or any agent that supports MCP. It sets up the connection for you. Manual setup
- 2
Sign in to Agensi
Your agent shows a sign-in link. Sign in and click Allow.
- 3
Ask for what you need
Your agent loads this skill and uses it on your task. It always asks before any payment.
Reviews
This skill has been used 40 times.
Trust & safety
Security scan
Security scan passed 5 months ago
- Free with an Agensi account
Requires
Permissions
File Scopes
README Generator reads repository manifests, source comments, existing documentation, and LICENSE files. It may use a local --help command only when that is likely safe and non-mutating. Write access creates or updates README.md; review the generated diff before committing. No browser, network, or environment-variable access is required.