README Writing

Overview

Write README files that help a visitor understand the project in the first screen, trust it within one minute, and try it without guessing. A good README is a landing page, setup guide, and trust signal at the same time.

When To Use

Use this skill when:

• Creating a new README.md.
• Rewriting a README for a public repository.
• Improving a README's clarity, structure, visuals, or quickstart.
• Adding badges, screenshots, diagrams, language links, or contribution sections.
• Making a repository more attractive for GitHub readers.

Do not use it for long-form product docs, API references, or internal-only runbooks unless the user specifically wants a README-style entry page.

Workflow