GitHub API + Code Analysis

Generate a perfect
README.md instantly

Paste any public GitHub repo URL. ReadmeForge reads the actual source code, detects the tech stack, and writes a comprehensive, detailed README — no API key required.

Repository URL
Works with any public GitHub repository  ·  Press Enter to generate  ·  AI Enhanced
Try an example:
No login required
100% client-side
GitHub Public REST API + Google Gemini 2.0 Flash AI
Code-aware mode — reads actual source files
Simple by design

How ReadmeForge works

From URL to polished README in four automated steps — no config, no templates, no guesswork.

01

Paste a GitHub URL

Enter the URL of any public GitHub repository. No tokens, no sign-in, no setup required. Optionally add your Gemini API key via the settings gear for AI-powered generation.

02

Deep repository analysis

ReadmeForge fetches the repo's file tree, metadata, config files (package.json, requirements.txt, Cargo.toml…) and actual source code entry points (main.py, index.ts, app.js…) via the GitHub API.

03

Code-aware README generation

ReadmeForge parses functions, classes, API routes, and imports from your source code to generate accurate, specific content — not generic filler. If a Gemini API key is set, Gemini Flash writes an even richer README.

04

Preview, copy, or download

View the rendered preview or switch to raw Markdown. Use split view to see both side-by-side. Copy to clipboard or download README.md directly.