forge-readme
CommunityWrite READMEs that install and deliver.
Content & Communication#documentation#verification#developer experience#readme#installation#quickstart#content quality
Authorf4rkh4d
Version1.0.0
Installs0
System Documentation
What problem does it solve?
It prevents AI-generated READMEs from shipping marketing fluff, missing installation/quickstart steps, and forcing users to scroll past decoration before they can try the project.
Core Features & Use Cases
- Disciplined README structure: Enforces a consistent section order and exactly one H1, keeping the page scannable.
- High-signal header + badges policy: Caps badges in the header (max 3) and requires the one-sentence description to appear promptly.
- Copy-paste quickstart formatting: Requires an install section and a first-viewport, copy-pastable quickstart that works immediately, with language-tagged code blocks and no placeholder identifiers.
Quick Start
Use forge-readme when creating or rewriting a project README by asking an AI to generate a README that follows the skill’s rules, then run the verifier on the resulting file.
Dependency Matrix
Required Modules
None requiredComponents
assets
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: forge-readme Download link: https://github.com/f4rkh4d/forge-skill/archive/main.zip#forge-readme Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.