README Style Guide

Principles

• No fluff - Skip tables of contents, verbose explanations, development history
• No roadmaps - Document current state only, not plans or decisions. Readme is an engineering specification. Not a project plan or changelog.
• No repetition - Each fact appears once
• No hype - Avoid "next generation", "production ready", "powerful", "comprehensive" and similar hyperbole
• Direct voice - State facts, not opinions
• No contrasting embellishments - Avoid like "not just a thing, it's a better thing", "not only a thing, it's something", "more than a"

Structure

Exclude

• Tables of contents
• Verbose troubleshooting guides
• Development decisions/history
• Future plans/roadmaps
• Lengthy explanations of concepts
• Multiple examples of similar things

Formatting

• Tables for structured data (components, variables, test coverage)
• Code blocks for commands and examples
• Bold for emphasis sparingly
• No emojis unless explicitly requested
• No emdashes