GITHUB REPO → READY DOCS

Your repo already explains itself.
Now it can say so.

Paste a repository link. RepoReader reads the file structure and source together, then drafts a README, API reference, setup guide, and architecture overview — ready to download or copy in minutes.

Free for your first repo. No credit card required.

repo/
├── src/
│   ├── index.ts
│   ├── router.ts
│   └── utils/parse.ts
├── package.json
└── README.md  (empty)
generated/
README.md
Router
A lightweight request router with typed middleware support.
Install with your package manager of choice
Configure routes in src/router.ts
Run npm run dev to start locally

Three commands, no manual writing.

fetch

Pull the repo

We read the file tree and source straight from the GitHub API. No cloning, no local setup, no access beyond what you grant.

generate

Draft the docs

Gemini reads the structure and code together, and writes documentation that matches how the project actually works.

ship

Take it with you

Download everything as a zip or copy it straight to your clipboard. Drop it in the repo and commit.

Four documents, every run.

R

README

What the project does, how to install it, and how to run it — written for someone opening the repo cold.

A

API reference

Every exported function, endpoint, and type, with parameters and return values pulled straight from the source.

S

Setup guide

Environment variables, dependencies, and the exact commands to get a contributor running locally.

O

Architecture overview

How the pieces fit together — modules, data flow, and the decisions that shaped the structure.

Free to try. Simple to scale.

FREE
$0/mo

One small repo a month, on us. See the quality before you pay for anything.

  • 1 repo per month (under ~50 files)
  • All four documents
  • Carries a "Generated with RepoReader" credit
PER REPO
$12/repo

One repository, any size, no credit line. Pay only when you need it.

  • No size limit
  • No "Generated with" credit
  • Download as .zip or copy to clipboard

Stop writing docs. Start shipping them.