Docs that write
themselves.
$ git push origin main
→ 3 files changed, docs updated automatically
✓ auth.ts · api/users.ts · lib/db.ts
// your code
export async function getSession(req) {
const token = req.cookies.get('token')
if (!token) return null
return verify(token, SECRET)
}
// generated docs
✓ getSession(req) → Session | null
Retrieves the current session from the request cookie.
Returns the verified payload, or null if no valid token.
▸ auto-updated on push · 142ms
// why we built this
Documentation has always been an afterthought.
Code moves fast.
You ship a fix at 11pm, rename a function, refactor a module. Docs written last month describe a system that no longer exists.
No one has time.
Writing docs is important but never urgent. It gets deferred, forgotten, or delegated to whoever has the least to do. Which is never anyone.
AI finally makes it possible.
We built Readmify because we wanted docs that update themselves, silently, every time code changes. Bring your own AI key and let it run.
// how it works
Zero effort. Always in sync.
$ readmify connect --provider github|bitbucket
Connect your repo
GitHub users install the Readmify App in one click. Bitbucket users log in with their account. Repos appear automatically.
$ git push origin main
Push your code
Your normal workflow, unchanged. Readmify listens to every commit automatically.
✓ 3 files documented
Docs appear instantly
AI analyzes the diff and updates only the docs that need to change.
$ readmify config --ai groq|gemini|claude|...
Choose your AI
Bring your own API key. Pick Groq, Gemini, Anthropic, OpenAI, or Mistral and switch anytime.
$ readmify export ./docs
Export anytime
Download your documentation as Markdown files, ready to ship or host anywhere.
$ readmify repo --pause
Pause when you need to
Releasing a new version? Pause a repo to skip doc updates during rapid pushes, then resume when you're ready.
✦ pretty
One-click formatting
AI output isn't always perfectly structured. Hit pretty to normalize headings, strip orphaned bullets, and space out entries. Without touching the content.
✎ edit
Edit docs in the browser
Need to add context the AI missed, or fix a description? Edit any doc directly in the browser. No commits, no friction.
$ readmify exclude node_modules/ dist/
Skip what doesn't matter
Define an exclusion list to skip library folders, build output, lockfiles, and generated code. No tokens wasted on files that don't need docs.
$ readmify config --extensions .ts .py .go
Choose which file types to document
Control exactly which file extensions trigger documentation. Add .java, .kt, .swift — or remove languages you don't need. Defaults to TypeScript, JavaScript, Python, Go, Rust, and Ruby.
$ readmify config --mode normal|smart|semantic
Regenerate only when needed
Smart mode skips pushes that only change whitespace, comments, or imports. Free, no AI call. Semantic mode goes further: a lightweight model checks whether the diff actually affects the documentation before triggering a full update.
—
repositories connected
—
docs generated
5
AI providers
50+
models supported
since 2026/07
// why free
At Poletto 1976 we dedicate 10% of our time to projects we believe should exist and be accessible to everyone. Readmify is one of them.
The platform is free. The AI isn't ours to give away.
You connect your own API key (Groq, Gemini, Anthropic, OpenAI, Mistral) and pay your provider directly, at their rates. We don't proxy it, we don't mark it up. Many providers have a free tier that's more than enough. We built the infrastructure; the inference is yours.
Good documentation tooling shouldn't be a privilege.