DarnlyREADME generator: a clean README.md in a minute
Fill in a few boxes and watch your README build itself, with badges, a screenshot, setup steps, an environment variable table and deploy buttons. Copy it, download it, or hand it to your AI agent.
Free from Darnly. Spot a bug in the app you're building? Darnly hands it to Claude Code, Codex or Cursor in one key.Add to Chrome
Everything stays in your browser.
Your project
Not sure? Leave it empty. The AI agent prompt writes this from your code.
Add your GitHub link above so the deploy buttons know which project to copy.
More free tools
See all 89 tools- JSON to TypeScriptPaste JSON and get TypeScript types and a Zod schema, with optional fields found for you.
- Diff checkerCompare two texts side by side and see every added, removed and changed word. Nothing is uploaded.
- px to rem converterpx to rem and back, live, with the matching Tailwind class and a ruler at real size.
How it works
- Type your project’s name and one line about what it does. Add your live link, your GitHub link and a screenshot link if you have them.
- Tick what you built it with, pick npm, pnpm, yarn or bun, and list the names of your environment variables. Never the values: if you paste
KEY=value, we drop the value. - Watch the README build itself at the top. Copy it, download
README.md, or copy the prompt for your AI agent, which adds the README to your project and writes the Features section from your code.
Questions
What is a README?
The README.md file is the front page of your project on GitHub. It tells people (and AI coding agents) what the project is, what it looks like and how to run it. A clear one makes a repo look finished.
Where do I put the file?
In the top folder of your project, next to package.json, named exactly README.md. GitHub shows it on your repo’s main page. Or copy the prompt and your AI agent will put it there for you.
Do you ask for my API keys?
No, and you shouldn’t put them in a README. You list only the names, like STRIPE_SECRET_KEY. If you paste a line with a value, we remove the value straight away. Everything stays in your browser.
How do I add a screenshot?
Take a screenshot of your app, put it in your project (for example public/screenshot.png) and push it to GitHub. Then paste its link here. A link to any image online works too, as long as it starts with https://.
What are the badges?
Small labels from shields.io that show your tech stack, license and live link at the top of the README. They’re just pictures, so they cost nothing and need no setup.
How do the deploy buttons work?
Someone clicks “Deploy with Vercel” or “Deploy to Netlify” and gets their own copy of your project deployed, with your environment variable names already listed. They need your GitHub link, and your repo has to be public.
I don’t know what features to list. What now?
Leave them empty and click “Copy prompt for your AI agent”. Paste it into Claude Code, Cursor or Codex. It reads your code and writes the Features section from what the app really does.