Documentation

Everything you need to know about ReadMeForge.

Quick Start

1.Go to the home page.
2.Paste any public GitHub repository URL into the input field (e.g. https://github.com/owner/repo).
3.Click Generate README. Your README is ready in seconds.
4.Copy the output or download it as README.md.

What Gets Detected

ReadMeForge analyzes your repository's file tree and package metadata — no AI inference, no hallucinations.

Framework

Next.js, React, Vue, Svelte, Express, Fastify, FastAPI, Django, Go, Rust, Java Spring

Package Manager

npm, yarn, pnpm, bun, pip, cargo, go modules, maven, gradle

Language

TypeScript, JavaScript, Python, Go, Rust, Java, Ruby, PHP

Tests

Jest, Vitest, Playwright, Cypress, pytest, go test — detected from config files

Docker

Detected if Dockerfile or docker-compose.yml is present

CI/CD

.github/workflows/, .circleci/, .travis.yml, GitLab CI

License

MIT, Apache 2.0, GPL, ISC — read from LICENSE file

Badges

Auto-generated for framework, package manager, license, tests, Docker

Generated README Structure

Every generated README follows this structure:

# Project Name

![Framework](badge) ![Tests](badge) ![License](badge)

> Short description from repository metadata

## Features
- Auto-detected features

## Tech Stack
- Framework, language, runtime

## Getting Started
### Prerequisites
### Installation
### Running the App

## Running Tests

## Project Structure

## License

Usage Limits

Plan	READMEs / month	Private repos	History
Free	5	No	No
Pro $9/mo	Unlimited	Yes	Yes

FAQ

Does it work with private repositories?

Private repository support is available on the Pro plan. You'll authenticate once and ReadMeForge will access your repos securely.

How accurate is the detection?

Detection is based on actual files in your repository — package.json, go.mod, Cargo.toml, etc. It doesn't guess or infer. If a config file is present, it's detected.

Can I customize the generated README?

After generating, copy the Markdown and edit it in any text editor or directly in GitHub. Custom section templates are coming to the Pro plan.

What if my framework isn't detected?

ReadMeForge supports 10+ frameworks. If yours isn't listed, the README will still be generated with the sections that can be detected. Open a request on our roadmap.

Is there an API?

A public API is planned for Pro users. The current tool is available via the web interface only.

Ready to generate your README?

Paste a GitHub URL and get a professional README in seconds.

Try ReadMeForge Free