README Generator
Build a professional README.md interactively
Sections
37 lines
README.md
1# my-project23A brief description of what this project does and who it is for.45## Features67- Feature one with a brief explanation8- Feature two with a brief explanation9- Feature three with a brief explanation1011## Installation1213```bash14npm install my-project15```1617## Usage1819```typescript20import { myFunction } from 'my-project';2122const result = myFunction({ option: true });23console.log(result);24```2526## Contributing27281. Fork the repository292. Create your feature branch (`git checkout -b feature/amazing-feature`)303. Commit your changes (`git commit -m 'add amazing feature'`)314. Push to the branch (`git push origin feature/amazing-feature`)325. Open a Pull Request3334## License3536MIT37
6 sections37 lines686 bytes
Get more AI dev tools, weekly
One short email a week with new tools, prompts, and Claude Code workflows. No spam.
More AI dev tools
Related reading
Watch the channel
Tutorials on Claude Code, MCP, AI agents, and shipping AI features in production.
FAQ
What is the AI-powered README generator?
It is a free tool that uses Anthropic's Claude API to generate a complete, production-quality README.md from a one-paragraph project description and an optional package.json snippet. The output streams in real time and includes title, badges, install, quick start, features, contributing, and license sections.
Are my inputs stored or logged?
No. Your description and package.json snippet are sent to the Claude API to generate the README and are never written to disk, database, or logs on our servers. The generated output lives only in your browser tab.
Is there a rate limit?
Yes. Each IP can make 5 AI generation requests every 15 minutes. The limit resets automatically. The classic template-based mode has no limit because it runs entirely in your browser.
What model does it use?
It uses Anthropic's Claude Sonnet model with streaming responses, so the README appears in real time as the model writes it.
Can I still use the manual template builder?
Yes. Toggle 'Template' at the top of the page to use the original interactive section builder with badges, drag-to-reorder, and live preview. The AI mode is an additional option, not a replacement.
What should I include in the project description?
One paragraph covering what your project does, who it is for, and one or two things that make it different. The more specific you are, the better the generated features and quick-start example will be.
Get Smarter About AI Dev
New tutorials, open-source projects, and deep dives on coding agents - delivered weekly.
One email per weekReal code, not theoryFree forever