README Gen
Generate beautiful README.md files with badges, installation instructions, usage examples, and API documentation from your codebase automatically.
🚀 Generate professional README files instantly from your codebase. This tool analyzes your project structure, package.json, and source files to create complete documentation with badges, installation instructions, API docs, and usage examples—all with a single command and zero configuration required.
💡 Perfect for launching new open source projects, publishing npm packages, or rescuing projects with missing or outdated documentation. Saves hours of manual writing while ensuring your project gets the attention it deserves.
✨ No API keys, no sign-ups, no paywalls. Just run npx ai-readme and get a polished README that actually makes people want to use your project.
Requirements
OPENAI_API_KEY environment variable for AI-powered content generation