readme-best-practices

Installation
SKILL.md

README Best Practices (2026)

This skill guides you through creating a best-practice GitHub README.md for 2026, including a custom SVG logo and shields.io badges.

When to activate

  • User asks to "write a README", "improve README", "add badges", or "create a logo"
  • User asks to analyze or audit an existing README.md
  • User wants to make a repository more professional or discoverable
  • User asks about GitHub documentation best practices

Step-by-step workflow

1. Analyze the repository

Before writing anything, gather context:

Installs
1
GitHub Stars
1
First Seen
Sep 26, 2026