readme-writer

A clear README uses short sentences, active voice, and organized sections covering what the project does, how to install it, and how to use it. This Skill generates READMEs enforcing ninth-grade reading level, GitHub-flavored Markdown, and semantic callouts like [NOTE] and [WARNING] to guide readers through your project.

A complete README covers what the package does, installation steps, usage examples, configuration options, contribution guidelines, developer environment setup, and portability considerations. This Skill provides a structured template organizing these sections in a logical flow that helps users understand and adopt your project.

Yes. This Skill enforces ESL-friendly writing by keeping sentences simple, using active voice, and maintaining a ninth-grade reading level. It also adds semantic callouts and clear formatting conventions so readers of all backgrounds can quickly understand your project's purpose and usage.

This Skill enforces GitHub-flavored Markdown formatting and includes scripts to apply consistent structure, callout styling, and readability standards across your entire README without manual formatting work.

Run this Skill on your current README to reorganize sections per the recommended template, simplify language to ninth-grade level, convert formatting to GitHub-flavored Markdown, and add semantic callouts where needed. The Skill handles both writing from scratch and improving existing documentation.