readme-builder

name	readme-builder
description	Generates readmes for humans

README Generator

When asked to create a README file, follow these guidelines:

Style

• Keep it short and scannable for humans
• Use plain, direct language
• No marketing speak or hype
• No emojis
• No badges unless explicitly requested
• No claims about test coverage or code quality

Structure

• Start with a one-line description of what it does
• Include installation instructions if applicable
• Show basic usage with a minimal example
• List dependencies only if they're not obvious
• Skip sections that would be empty or filler

Tone

• Write like documentation, not advertising
• State facts, not promises
• If something is limited or experimental, say so
• Assume the reader is technical