- Home
- Skills
- Technical Documentation
- readme-gen
Readme Gen
Deep project analysis to generate professional README.md files with API references, scripts, and stack detection.
$12
Works with the AI Agents you already use
readme-gen
Example session with this skill installed
Generate a readme for this auth-proxy project. Include the version from package.json, the key features you find in src, and a table of the npm scripts.
- Read your context and instructions
- Compiled the readme-gen
Auth-Proxy v1.2.0
Lightweight OAuth2 proxy for internal services.
Features
- JWT Validation via RSA
- Redis-backed session storage
Scripts
| Command | Description |
|---|---|
| npm start | Start production server |
| npm test | Run jest test suites |
License
MIT
Connects securely to your tools. The creator never sees your data.
About this skill
What it does
The readme-gen skill automates the creation of high-quality, professional README documentation by performing a deep analysis of your codebase. Instead of manually typing out folder structures or hunting for dependency versions, this skill reads your project manifests (like package.json, pyproject.toml, or cargo.toml) and source files to build a structured, accurate technical document.
How it works
The skill follows a multi-step discovery process to ensure accuracy:
- Metadata Extraction: Identifies project name, version, and license from system manifests.
- Stack Detection: Uses glob patterns to identify languages (TS, Python, Go, Rust) and frameworks (Next.js, Vite, Docker).
- API Mapping: Reads entry points to automatically document exported functions and classes.
- Environment Discovery: Detects required environment variables via .env fragments and documentation.
Why use this skill?
Writing documentation is often the last thing developers want to do. Setting up a high-level README manually is prone to getting outdated. Since this skill analyzes the actual code and file structure, it reflects the true state of your project. It’s significantly faster than manual prompting because it knows exactly which files to audit and how to format shields.io badges and script tables for a standard repository look.
- Best for standard structures; complex mono-repos may need manual adjustment.
- May miss logic-heavy features not explicitly defined in manifest files or exported signatures.
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
No reviews yet
Be one of the first to try it. Every listed skill goes through the trust checks below.
Security scanned
Checked by our 8-point scan before listing
Fresh listing
Recently published to Agensi
Money-back guarantee
Doesn't do what its page promises? You get your money back.
Trust & safety
Security scan
Security scan passed 7 months ago
Requires