https://github.com/rushikeshsakharleofficial/readme-forge
Auto-generates production-quality README files for Claude Code. Stack-aware, 6 project types, 3 styles, zero placeholder text.
https://github.com/rushikeshsakharleofficial/readme-forge
claude-code documentation generator markdown plugin readme
Last synced: 30 days ago
JSON representation
Auto-generates production-quality README files for Claude Code. Stack-aware, 6 project types, 3 styles, zero placeholder text.
- Host: GitHub
- URL: https://github.com/rushikeshsakharleofficial/readme-forge
- Owner: rushikeshsakharleofficial
- License: mit
- Created: 2026-06-17T06:13:14.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2026-06-17T06:30:16.000Z (about 1 month ago)
- Last Synced: 2026-06-17T08:17:44.947Z (about 1 month ago)
- Topics: claude-code, documentation, generator, markdown, plugin, readme
- Size: 34.2 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# README Forge
### Auto-generates production-quality README files from project context.
6 project types · 3 output styles · SEO-optimized output · zero placeholder text
> *"Every dev who's had Claude write a README knows the result: generic Tailwind purple, placeholder text, badges that 404, and a feature list that was invented on the spot."* README Forge ends that.
What makes it different
Six things every other README generator gets wrong.
Reads Your Project First
Scans package.json, lockfiles, directory structure, CI configs, and entry points before writing a single word. Output reflects what's actually in the repo.
No Invented Content
Every claim is verified. If a fact can't be found in the project, it goes into a Maintainer TODOs section with a precise question — never invented.
Type-Aware Structure
Library, CLI tool, SaaS app, Claude Code plugin, API/backend, open-source. Each has a different section order, different content priorities, different style defaults.
Rich, Minimal, or Dark
--style rich: typing SVG hero, dark badges, 3-column feature tables. --style minimal: clean prose, flat badges, code first. --style dark: AMOLED-first with violet/cyan accents.
GitHub + Google Discoverable
Keyword-first H1, optimized opening paragraph (120–160 chars for snippet display), verified badge URLs, correct internal links. Output ranks.
Badges That Don't 404
Only adds a badge if the thing it represents exists: CI badge needs a workflow file, npm badge needs a published package, license badge needs a LICENSE file.
## Install
```bash
/plugin marketplace add rushikeshsakharleofficial/readme-forge
/plugin install readme-forge@readme-forge
```
Or via CLI:
```bash
claude plugin marketplace add rushikeshsakharleofficial/readme-forge
claude plugin install readme-forge@readme-forge
```
## Usage
```bash
# Auto-detect project type and generate
/readme-forge:readme
# Force a style
/readme-forge:readme --style rich
/readme-forge:readme --style minimal
/readme-forge:readme --style dark
# Force a project type
/readme-forge:readme --type library
/readme-forge:readme --type cli-tool
/readme-forge:readme --type plugin
# Update an existing README (preserve structure, refresh content)
/readme-forge:readme --update
# Generate only one section
/readme-forge:section features
/readme-forge:section install --style rich
/readme-forge:section api
# Generate badges only
/readme-forge:badges
/readme-forge:badges --dark
```
## Context-aware activation
| You type… | README Forge does… | You get… |
|---|---|---|
| `/readme-forge:readme` | Scans project, detects type + style | Full README matched to your stack |
| `/readme-forge:readme --style rich` | Forces Darkforge-style visual layout | Dark badges, typing hero, feature tables |
| `/readme-forge:readme --style minimal` | Forces clean prose layout | ripgrep/zustand-style, code first |
| `/readme-forge:readme --type cli-tool` | Overrides auto-detection | CLI-optimized: install-by-platform, flag table |
| `/readme-forge:readme --update` | Reads existing README | Refreshes stale sections, keeps structure |
| `/readme-forge:section api` | Scans exports and routes | API reference table for your endpoints |
| `/readme-forge:badges` | Checks CI, license, package | Verified badge row, no 404s |
## Project type auto-detection
| Signal in your project | Detected type |
|---|---|
| `.claude-plugin/plugin.json` | `plugin` |
| `bin` in `package.json` or `cmd/` directory | `cli-tool` |
| `next.config.*` or `vite.config.*` + `src/app/` | `saas-app` |
| `exports` / `main` in `package.json`, no framework in deps | `library` |
| `express` / `fastapi` / `hono` / `gin` in deps | `api` |
| Rust `lib.rs`, Go package (non-main) | `library` |
| Fallback | `open-source` |
## Skills
| Skill | Use |
|---|---|
| `/readme-forge:readme` | Generate or update a complete README |
| `/readme-forge:section ` | Generate one section: `badges`, `hero`, `features`, `install`, `usage`, `api`, `config`, `contributing`, `license`, `structure` |
| `/readme-forge:badges` | Generate a verified badge row |
## Architecture
Plugin structure — click to expand
```
readme-forge/
├── .claude-plugin/
│ ├── plugin.json
│ └── marketplace.json
├── skills/
│ ├── readme/
│ │ ├── SKILL.md ← main brain: scan → classify → style → generate
│ │ └── references/
│ │ ├── 00-project-analysis.md ← what to scan and how to interpret it
│ │ ├── 01-badges.md ← complete badge catalog with verified URLs
│ │ ├── 02-sections.md ← all section templates
│ │ ├── 03-style-guides.md ← rich / minimal / dark / SEO rules
│ │ └── patterns/
│ │ ├── library.md ← zustand/tRPC/vite style
│ │ ├── cli-tool.md ← ripgrep/gh CLI style
│ │ ├── saas-app.md ← Next.js / startup style
│ │ ├── plugin.md ← Darkforge / linux-admin style
│ │ ├── api.md ← Express / FastAPI style
│ │ └── open-source.md ← scripts / configs / templates
│ ├── section/
│ │ └── SKILL.md ← single-section generator
│ └── badges/
│ └── SKILL.md ← badge-only generator
└── README.md
```
The `readme` skill loads `SKILL.md` first (lean brain — scan, classify, route). Reference and pattern files load on demand based on what your project is, keeping every interaction fast and token-efficient.
## Why README Forge
| | Other README generators | **README Forge** |
|---|---|---|
| **Content source** | AI imagination | **Verified project files** |
| **Project types** | Generic | **6 specialized patterns** |
| **Output styles** | One | **3 (rich, minimal, dark)** |
| **Badges** | Often 404 | **Only verified badges** |
| **SEO** | None | **Keyword-first H1, optimized snippet** |
| **Placeholder text** | Common | **Zero — uses Maintainer TODOs** |
| **Single section** | Full regen only | **`/readme-forge:section `** |
| **Badges only** | Full regen only | **`/readme-forge:badges`** |
---
MIT licensed. Write READMEs worth reading.
Built by Rushikesh.