Forge a perfect README from any GitHub repository

Readme Forge pulls real repository metadata, detects your tech stack, and uses OpenRouter to write documentation that fits your template exactly.

Source Repository

GitHub Repository URL

API Key

Optional. Leave blank to use the OPENROUTER_API_KEY configured on the server.

README Template

Template style

Enterprise-grade skeleton: emoji title with blockquote, Skillicons header, categorized features, full setup guide, and project tree.

Template source

# 🚀 {{repo_name}} - Enterprise Platform

> {{short_description}}

---

## 🌟 Overview

**{{repo_name}}** is a high-performance platform designed to...

### Why {{repo_name}}?

* **Unified Workspace:** Streamlines project workflows and data management into one solution.
* **Modern Stack:** Built on modern infrastructure and clean architectural principles.
* **Automated Data Flow:** Handles complex background logic and real-time processing seamlessly.

---

## ✨ Features

### 🎯 Core Features
* {{core_feature_1}}
* {{core_feature_2}}

### 🔧 Technical Highlights
* {{tech_highlight_1}}
* {{tech_highlight_2}}

---

## 🛠 Technologies Used

---

## 📦 Installation

Clone the repository:
```bash
git clone {{repo_url}}.git
cd {{repo_name}}
```

Install dependencies:
```bash
pnpm install
```

---

## 🚀 Usage

Start the development server:
```bash
pnpm dev
```

---

## 📁 Project Structure

```text
{{file_tree}}
```

---

## 🤝 Contributing

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

---

## 👨‍💻 Author

GitHub: {{repo_owner}}

1367 chars

Your README will appear here

Streamed live from OpenRouter — three steps to get going.

Paste a repo URL

Fetch live metadata, file tree & stack

Choose a template

Or paste your own structure

Generate & export

Copy or download README.md