- Home
- Skills
- Technical Documentation
- readme-generator
Readme Generator
Generates a complete, polished README.md by scanning your actual project structure, dependencies, and code.
Free
Works with the AI Agents you already use
readme-generator
Example session with this skill installed
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.
- Read your context and instructions
- Compiled the readme-generator
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.
Connects securely to your tools. The creator never sees your data.
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 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
Trust & safety
Security scan
Security scan passed with 2 warnings 7 months ago
- Free with an Agensi account
Requires