$ skilldirectory
— zsh — registry.skilldirectory.dev
skill library blog

home / Writing / Readme Polish Skill by @alirezarezvani

Readme Polish Skill by @alirezarezvani

FREE
github stars★ 29,369updatedNov 2026repo@alirezarezvani
$git clone https://github.com/alirezarezvani/claude-skills

The skill is the engineering/readme-polish folder inside that repository. Copy it into the folder your agent loads skills from; check your agent's documentation for where that is.

Read the opening of the original SKILL.md
# README Polish

Upgrade an **existing** README to the standard of the leading repos in its own ecosystem. Polish is
information hierarchy that survives a 15-second skim; every component must earn its place. This is
not a generator: no banner for a single-tool repo, no badge for a service that does not exist, no
screenshot placeholder.

Do not use it for a README with no content yet, for hero or banner image design, or for API
reference docs. If the README is already accurate and scannable, say so and propose a smaller change.

## Before starting

Ask only what the repo cannot tell you: the category (single tool, library or framework, collection,
commercial product), the audience (evaluating developers or installing users), and which claims are
true today (version, license, test status).

## Modes

- **Upgrade** (default): run the full workflow and rewrite the file.
- **Audit only**: run steps 1-3 and 5, report findings with line references, do not rewrite.
…

Excerpt only, quoted from the author's repository. Open the repository for the complete file.