{"id":50992806,"url":"https://github.com/rushikeshsakharleofficial/readme-forge","last_synced_at":"2026-06-20T05:04:07.188Z","repository":{"id":365401782,"uuid":"1271927067","full_name":"rushikeshsakharleofficial/readme-forge","owner":"rushikeshsakharleofficial","description":"Auto-generates production-quality README files for Claude Code. Stack-aware, 6 project types, 3 styles, zero placeholder text.","archived":false,"fork":false,"pushed_at":"2026-06-17T06:30:16.000Z","size":35,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-17T08:17:44.947Z","etag":null,"topics":["claude-code","documentation","generator","markdown","plugin","readme"],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rushikeshsakharleofficial.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-06-17T06:13:14.000Z","updated_at":"2026-06-17T06:30:21.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/rushikeshsakharleofficial/readme-forge","commit_stats":null,"previous_names":["rushikeshsakharleofficial/readme-forge"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/rushikeshsakharleofficial/readme-forge","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rushikeshsakharleofficial%2Freadme-forge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rushikeshsakharleofficial%2Freadme-forge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rushikeshsakharleofficial%2Freadme-forge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rushikeshsakharleofficial%2Freadme-forge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rushikeshsakharleofficial","download_url":"https://codeload.github.com/rushikeshsakharleofficial/readme-forge/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rushikeshsakharleofficial%2Freadme-forge/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34557553,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-20T02:00:06.407Z","response_time":98,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["claude-code","documentation","generator","markdown","plugin","readme"],"created_at":"2026-06-20T05:04:05.991Z","updated_at":"2026-06-20T05:04:07.183Z","avatar_url":"https://github.com/rushikeshsakharleofficial.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# README Forge\n\n### Auto-generates production-quality README files from project context.\n\n\u003ca href=\"https://readme-typing-svg.demolab.com/?font=JetBrains+Mono\u0026weight=600\u0026size=20\u0026duration=2400\u0026pause=700\u0026color=A78BFA\u0026center=true\u0026vCenter=true\u0026width=720\u0026height=44\u0026lines=One+command.+A+README+worth+reading.;Stack-aware.+Never+generic.;library+%E2%86%92+cli+%E2%86%92+plugin+%E2%86%92+api+%E2%86%92+saas.;No+placeholders.+No+invented+facts.\"\u003e\n  \u003cimg src=\"https://readme-typing-svg.demolab.com/?font=JetBrains+Mono\u0026weight=600\u0026size=20\u0026duration=2400\u0026pause=700\u0026color=A78BFA\u0026center=true\u0026vCenter=true\u0026width=720\u0026height=44\u0026lines=One+command.+A+README+worth+reading.;Stack-aware.+Never+generic.;library+%E2%86%92+cli+%E2%86%92+plugin+%E2%86%92+api+%E2%86%92+saas.;No+placeholders.+No+invented+facts.\" alt=\"Typing tagline\" /\u003e\n\u003c/a\u003e\n\n\u003cp\u003e\n  \u003cimg src=\"https://img.shields.io/badge/license-MIT-000000?style=for-the-badge\u0026labelColor=000000\u0026color=A78BFA\" alt=\"MIT License\" /\u003e\n  \u003cimg src=\"https://img.shields.io/badge/Claude_Code-Plugin-000000?style=for-the-badge\u0026labelColor=000000\u0026color=A78BFA\" alt=\"Claude Code Plugin\" /\u003e\n  \u003cimg src=\"https://img.shields.io/badge/skills-3-000000?style=for-the-badge\u0026labelColor=000000\u0026color=22D3EE\" alt=\"3 Skills\" /\u003e\n  \u003cimg src=\"https://img.shields.io/badge/styles-rich%20·%20minimal%20·%20dark-000000?style=for-the-badge\u0026labelColor=000000\u0026color=F472B6\" alt=\"3 Styles\" /\u003e\n  \u003cimg src=\"https://img.shields.io/badge/types-6-000000?style=for-the-badge\u0026labelColor=000000\u0026color=22D3EE\" alt=\"6 Project Types\" /\u003e\n\u003c/p\u003e\n\n\u003csub\u003e\u003cb\u003e6 project types\u003c/b\u003e · \u003cb\u003e3 output styles\u003c/b\u003e · \u003cb\u003eSEO-optimized output\u003c/b\u003e · \u003cb\u003ezero placeholder text\u003c/b\u003e\u003c/sub\u003e\n\n\u003c/div\u003e\n\n\u003cimg src=\"https://capsule-render.vercel.app/api?type=waving\u0026color=0:000000,50:A78BFA,100:22D3EE\u0026height=4\u0026section=header\" width=\"100%\" /\u003e\n\n\u003e *\"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.\n\n\u003cdiv align=\"center\"\u003e\n\n\u003ch2\u003eWhat makes it different\u003c/h2\u003e\n\n\u003csub\u003eSix things every other README generator gets wrong.\u003c/sub\u003e\n\n\u003c/div\u003e\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd width=\"33%\" valign=\"top\" align=\"center\"\u003e\n      \u003cimg src=\"https://img.shields.io/badge/-STACK--AWARE-A78BFA?style=for-the-badge\u0026labelColor=000000\" /\u003e\u003cbr /\u003e\u003cbr /\u003e\n      \u003cb\u003eReads Your Project First\u003c/b\u003e\n      \u003cp align=\"left\"\u003e\u003csub\u003eScans \u003ccode\u003epackage.json\u003c/code\u003e, lockfiles, directory structure, CI configs, and entry points before writing a single word. Output reflects what's actually in the repo.\u003c/sub\u003e\u003c/p\u003e\n    \u003c/td\u003e\n    \u003ctd width=\"33%\" valign=\"top\" align=\"center\"\u003e\n      \u003cimg src=\"https://img.shields.io/badge/-ZERO%20PLACEHOLDERS-22D3EE?style=for-the-badge\u0026labelColor=000000\" /\u003e\u003cbr /\u003e\u003cbr /\u003e\n      \u003cb\u003eNo Invented Content\u003c/b\u003e\n      \u003cp align=\"left\"\u003e\u003csub\u003eEvery claim is verified. If a fact can't be found in the project, it goes into a \u003ccode\u003eMaintainer TODOs\u003c/code\u003e section with a precise question — never invented.\u003c/sub\u003e\u003c/p\u003e\n    \u003c/td\u003e\n    \u003ctd width=\"33%\" valign=\"top\" align=\"center\"\u003e\n      \u003cimg src=\"https://img.shields.io/badge/-6%20PROJECT%20TYPES-F472B6?style=for-the-badge\u0026labelColor=000000\" /\u003e\u003cbr /\u003e\u003cbr /\u003e\n      \u003cb\u003eType-Aware Structure\u003c/b\u003e\n      \u003cp align=\"left\"\u003e\u003csub\u003eLibrary, CLI tool, SaaS app, Claude Code plugin, API/backend, open-source. Each has a different section order, different content priorities, different style defaults.\u003c/sub\u003e\u003c/p\u003e\n    \u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd width=\"33%\" valign=\"top\" align=\"center\"\u003e\n      \u003cimg src=\"https://img.shields.io/badge/-3%20STYLES-A78BFA?style=for-the-badge\u0026labelColor=000000\" /\u003e\u003cbr /\u003e\u003cbr /\u003e\n      \u003cb\u003eRich, Minimal, or Dark\u003c/b\u003e\n      \u003cp align=\"left\"\u003e\u003csub\u003e\u003ccode\u003e--style rich\u003c/code\u003e: typing SVG hero, dark badges, 3-column feature tables. \u003ccode\u003e--style minimal\u003c/code\u003e: clean prose, flat badges, code first. \u003ccode\u003e--style dark\u003c/code\u003e: AMOLED-first with violet/cyan accents.\u003c/sub\u003e\u003c/p\u003e\n    \u003c/td\u003e\n    \u003ctd width=\"33%\" valign=\"top\" align=\"center\"\u003e\n      \u003cimg src=\"https://img.shields.io/badge/-SEO%20OPTIMIZED-22D3EE?style=for-the-badge\u0026labelColor=000000\" /\u003e\u003cbr /\u003e\u003cbr /\u003e\n      \u003cb\u003eGitHub + Google Discoverable\u003c/b\u003e\n      \u003cp align=\"left\"\u003e\u003csub\u003eKeyword-first H1, optimized opening paragraph (120–160 chars for snippet display), verified badge URLs, correct internal links. Output ranks.\u003c/sub\u003e\u003c/p\u003e\n    \u003c/td\u003e\n    \u003ctd width=\"33%\" valign=\"top\" align=\"center\"\u003e\n      \u003cimg src=\"https://img.shields.io/badge/-BADGE%20VERIFIED-F472B6?style=for-the-badge\u0026labelColor=000000\" /\u003e\u003cbr /\u003e\u003cbr /\u003e\n      \u003cb\u003eBadges That Don't 404\u003c/b\u003e\n      \u003cp align=\"left\"\u003e\u003csub\u003eOnly 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.\u003c/sub\u003e\u003c/p\u003e\n    \u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n\u003cimg src=\"https://capsule-render.vercel.app/api?type=waving\u0026color=0:22D3EE,50:A78BFA,100:000000\u0026height=4\u0026section=footer\" width=\"100%\" /\u003e\n\n\u003c/div\u003e\n\n## Install\n\n```bash\n/plugin marketplace add rushikeshsakharleofficial/readme-forge\n/plugin install readme-forge@readme-forge\n```\n\nOr via CLI:\n\n```bash\nclaude plugin marketplace add rushikeshsakharleofficial/readme-forge\nclaude plugin install readme-forge@readme-forge\n```\n\n## Usage\n\n```bash\n# Auto-detect project type and generate\n/readme-forge:readme\n\n# Force a style\n/readme-forge:readme --style rich\n/readme-forge:readme --style minimal\n/readme-forge:readme --style dark\n\n# Force a project type\n/readme-forge:readme --type library\n/readme-forge:readme --type cli-tool\n/readme-forge:readme --type plugin\n\n# Update an existing README (preserve structure, refresh content)\n/readme-forge:readme --update\n\n# Generate only one section\n/readme-forge:section features\n/readme-forge:section install --style rich\n/readme-forge:section api\n\n# Generate badges only\n/readme-forge:badges\n/readme-forge:badges --dark\n```\n\n## Context-aware activation\n\n| You type… | README Forge does… | You get… |\n|---|---|---|\n| `/readme-forge:readme` | Scans project, detects type + style | Full README matched to your stack |\n| `/readme-forge:readme --style rich` | Forces Darkforge-style visual layout | Dark badges, typing hero, feature tables |\n| `/readme-forge:readme --style minimal` | Forces clean prose layout | ripgrep/zustand-style, code first |\n| `/readme-forge:readme --type cli-tool` | Overrides auto-detection | CLI-optimized: install-by-platform, flag table |\n| `/readme-forge:readme --update` | Reads existing README | Refreshes stale sections, keeps structure |\n| `/readme-forge:section api` | Scans exports and routes | API reference table for your endpoints |\n| `/readme-forge:badges` | Checks CI, license, package | Verified badge row, no 404s |\n\n## Project type auto-detection\n\n| Signal in your project | Detected type |\n|---|---|\n| `.claude-plugin/plugin.json` | `plugin` |\n| `bin` in `package.json` or `cmd/` directory | `cli-tool` |\n| `next.config.*` or `vite.config.*` + `src/app/` | `saas-app` |\n| `exports` / `main` in `package.json`, no framework in deps | `library` |\n| `express` / `fastapi` / `hono` / `gin` in deps | `api` |\n| Rust `lib.rs`, Go package (non-main) | `library` |\n| Fallback | `open-source` |\n\n## Skills\n\n| Skill | Use |\n|---|---|\n| `/readme-forge:readme` | Generate or update a complete README |\n| `/readme-forge:section \u003cname\u003e` | Generate one section: `badges`, `hero`, `features`, `install`, `usage`, `api`, `config`, `contributing`, `license`, `structure` |\n| `/readme-forge:badges` | Generate a verified badge row |\n\n## Architecture\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cb\u003ePlugin structure\u003c/b\u003e — click to expand\u003c/summary\u003e\n\n```\nreadme-forge/\n├── .claude-plugin/\n│   ├── plugin.json\n│   └── marketplace.json\n├── skills/\n│   ├── readme/\n│   │   ├── SKILL.md                    ← main brain: scan → classify → style → generate\n│   │   └── references/\n│   │       ├── 00-project-analysis.md  ← what to scan and how to interpret it\n│   │       ├── 01-badges.md            ← complete badge catalog with verified URLs\n│   │       ├── 02-sections.md          ← all section templates\n│   │       ├── 03-style-guides.md      ← rich / minimal / dark / SEO rules\n│   │       └── patterns/\n│   │           ├── library.md          ← zustand/tRPC/vite style\n│   │           ├── cli-tool.md         ← ripgrep/gh CLI style\n│   │           ├── saas-app.md         ← Next.js / startup style\n│   │           ├── plugin.md           ← Darkforge / linux-admin style\n│   │           ├── api.md              ← Express / FastAPI style\n│   │           └── open-source.md      ← scripts / configs / templates\n│   ├── section/\n│   │   └── SKILL.md                    ← single-section generator\n│   └── badges/\n│       └── SKILL.md                    ← badge-only generator\n└── README.md\n```\n\nThe `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.\n\n\u003c/details\u003e\n\n## Why README Forge\n\n| | Other README generators | **README Forge** |\n|---|---|---|\n| **Content source** | AI imagination | **Verified project files** |\n| **Project types** | Generic | **6 specialized patterns** |\n| **Output styles** | One | **3 (rich, minimal, dark)** |\n| **Badges** | Often 404 | **Only verified badges** |\n| **SEO** | None | **Keyword-first H1, optimized snippet** |\n| **Placeholder text** | Common | **Zero — uses Maintainer TODOs** |\n| **Single section** | Full regen only | **`/readme-forge:section \u003cname\u003e`** |\n| **Badges only** | Full regen only | **`/readme-forge:badges`** |\n\n---\n\n\u003cdiv align=\"center\"\u003e\n\n\u003csub\u003eMIT licensed. Write READMEs worth reading.\u003c/sub\u003e\n\n\u003csub\u003eBuilt by \u003ca href=\"https://github.com/rushikeshsakharleofficial\"\u003e\u003cb\u003eRushikesh\u003c/b\u003e\u003c/a\u003e.\u003c/sub\u003e\n\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frushikeshsakharleofficial%2Freadme-forge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frushikeshsakharleofficial%2Freadme-forge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frushikeshsakharleofficial%2Freadme-forge/lists"}