Crafting README.md Files for GitHub

Core insight: A README is a sales pitch, onboarding guide, and reference manual compressed into one document. Lead with value, prove with examples, document with precision.

Why This Matters

Most READMEs fail because they:

• Bury the value proposition under installation steps
• Explain what the tool IS instead of what problem it SOLVES
• Lack concrete examples (abstract descriptions don't sell)
• Miss the "quick escape hatch" for impatient users (curl one-liner)
• Don't show how it compares to alternatives

Great READMEs convert scanners into users in under 60 seconds.

THE EXACT PROMPT — README Revision