skills sourced live from GitHub · all skills listed are free · each skill is provided under its author's license.
home / Writing / Readme Polish Skill by @alirezarezvani
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.
Upgrades an existing README: hierarchy, badges, diagrams and collapsible sections, benchmarked against leading repos.
Focuses on information that survives a quick skim, and refuses decoration with no purpose, such as banners for a single-tool repo or fake badges.
The original SKILL.md is organised into these sections:
Written and maintained by @alirezarezvani. It is published under the MIT license, which allows reuse with attribution. See the author profile. SkillDirectory does not claim authorship: this page adds our own review and links back to the original, and the skill's text belongs to its author.
# 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.