Paste a GitHub URL. Get a production-quality README in 30 seconds. ReadMeForge reads your actual code — not a template.
Free for public repos. No account required. Pro plan $9/month.
Trusted by developers at
Every developer has 3-5 GitHub repos with embarrassing documentation. A blank README or a template that still says [Project Name] at the top.
It's not laziness. Writing documentation requires stepping outside your own head and explaining your project to someone who has never seen it. That's hard. By the time you want to do it, the context has evaporated.
README generators exist, but they're all forms with different clothes. You still write every word. You still have to look up which shields.io badge works for your project.
ReadMeForge is different. It reads your code.
# My Awesome Project
TODO: Add description
## Installation npm install
# My Awesome Project
[] [] []
Generates X from Y with Z.
## Installation
```bash pnpm install my-pkg ```
## Configuration
| Variable | Required |
Public repo? No login required. Private repo? Connect your GitHub account in one click.
Reads package.json, scans source files, extracts API routes, identifies environment variables, maps dependency stack. Not guessing — reading.
Accurate installation instructions, real code examples, configuration reference, stack-matched badges, and a quality score that tells you exactly where it could be stronger.
Every section is generated from actual code analysis, not filled-in blanks.
Detect your package manager from your lockfile. pnpm repos get pnpm commands. Dockerfile present? Docker instructions included. No more npm/yarn mismatches.
Scans .env.example and source files for every process.env call. Complete configuration table with variable names, descriptions, and required/optional status.
Express, Next.js, FastAPI, Django, Flask, Gin — enumerate your actual routes and generate a reference table with method, path, and inferred description.
Detect your CI system, package registry, test framework, and deployment target. Badges that work for your specific project with valid shields.io URLs.
Pull real code patterns from your source files to illustrate how the project is used. Not invented examples — yours.
Every README gets a score from 0 to 100 across completeness, accuracy, clarity, visual structure, and currency. Low section? Specific fix suggestions.
Most README tools give you output and wish you luck. ReadMeForge runs your generated README through a five-part quality analysis the moment it's generated.
Completeness
All essential sections present and substantive
Accuracy
Claims match actual codebase — package names, commands, env vars
Clarity
First sentence passes the 'what does this do' test
Visual Structure
Badges valid, TOC present for long docs, heading hierarchy
Currency
Dynamic version badges, CI status, maintenance signals
Example Quality Score
example/repo
The free tier is genuinely useful. The paid tier is where ReadMeForge becomes part of your workflow.
Connect your GitHub account and generate READMEs for private repos. Read-only access. No code stored.
Register a webhook and get a pull request with an updated README every time you push to main. Documentation that evolves with your code.
Generate a CHANGELOG.md from your commit history and merged PRs. 90 days of activity, Keep a Changelog format.
Define required sections, section order, tone, preferred badges, and custom sections. Every repo follows the same standard.
Add content ReadMeForge doesn't generate. Mark it as custom and it survives every auto-regeneration.
No daily caps. Generate READMEs for all your repos. Re-generate after major feature launches. Use it in your pipeline.
| Feature | ReadMeForge | readme.so | ChatGPT | Copilot |
|---|---|---|---|---|
| Reads actual source code | Yes | No | No | Partial |
| Accurate install commands | Yes | No | No | No |
| Environment variable extraction | Yes | No | No | No |
| API route documentation | Yes | No | No | No |
| Quality scoring | Yes | No | No | No |
| Private repo support | Pro | No | N/A | Yes |
| Auto-regeneration on push | Pro | No | No | No |
| Changelog generation | Pro | No | No | No |
| Team style guides | Pro | No | No | No |
| Price | Free / $9/mo | Free | $20/mo | $10/mo |
"I've been shipping side projects for 8 years. The README is always the last thing I do and it always shows. ReadMeForge generated a README for my CLI tool that was more accurate than what I would have written myself. It found the env vars I forgot to document."
Marcus Chen
Indie hacker, author of 12 npm packages
"We have 40 internal repos. Every one has a different README format, different levels of quality, some are completely empty. We set up a team style guide and ran it against everything in a weekend. Onboarding new engineers went from 2.5 days to less than 1."
Priya Sharma
Tech Lead at a Series A fintech startup
"The quality score is what sold me. I thought my READMEs were fine. They scored 52/100 on average. The accuracy section was failing because I'd hardcoded outdated package names. Fixed them all in an afternoon."
Daniel Novak
Open source maintainer, 3 projects with 1k+ stars
"The auto-regeneration webhook is exactly what I needed. My project's API changes constantly during early development. Before, my README was wrong within a week. Now it just stays accurate."
Aisha Williams
Developer at a developer tools startup
No credit card required
Pick any repo you've been meaning to write a README for. Paste the URL. Thirty seconds from now, you'll have a README that makes the project look like it deserves the stars it doesn't have yet.
Or start the 14-day Pro trial and bring your private repos.