readme-polish

Featured

Audit a GitHub README and rewrite it using modern 2025-2026 patterns — centered header, badges, hero image, GitHub alert callouts, emoji-prefixed features, expandable details, Mermaid diagrams, tables over dense prose. Produces a scannable README that works for a 10-second skim and a deep dive.

Code & Development 245 stars 27 forks Updated today Apache-2.0

Install

View on GitHub

Quality Score: 88/100

Stars 20%
80
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Readme Polish ## Overview Modern GitHub READMEs are **scannable first, readable second**. A skimmer should understand what the project does, who it is for, and how to install it in 10 seconds. Motivated readers get more detail from collapsibles, tables, and follow-up sections. This skill takes an existing README (or a blank slate) and rewrites it using the visual and layout patterns that well-regarded 2025-2026 open-source projects have converged on. It does **not** invent the content; content comes from the project itself. It shapes how that content is presented. ## When to Use - A README is a text wall with no visual anchors and no one can tell what the project does from a first glance. - An OSS release is about to ship and the README has not been pass-edited for discoverability. - The README mixes reference material with quickstart, so the install path is buried. - Publishing badges, adding a hero image, or restructuring sections would measurably help adoption. - A practitioner with social credibility wants the README to convey both "this is legit" and "here is how to use it" without competing for attention. ## When NOT to Use - The README already follows the patterns below and the content is fine. Do not thrash for style. - The project is internal / private / never published. No audience to optimize for. - The project needs documentation at site-level scale (tutorials, API reference, cookbook). README polish only covers the repo root; use Sphinx / MkDocs / Docusa...

Details

Author
yzhao062
Repository
yzhao062/anywhere-agents
Created
5 months ago
Last Updated
today
Language
Python
License
Apache-2.0

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Listed

readme-polisher

Improve the prose, headings, and structure of a README.md file. Use when the user asks to clean up or polish a README.

0 Updated 2 weeks ago
MLSecOpsHub
Data & Documents Listed

readme-skills

Create, audit, optimize, restructure, translate, or release-sync repository README files by inspecting actual project evidence and automatically matching the repository type, reader journey, maturity, and hosting constraints. Use when a project has no README, has an incomplete or outdated README, needs a professional rewrite, needs a repository-specific structure, or needs README visuals, badges, architecture diagrams, multilingual navigation, or release-aligned documentation. Do not use for personal GitHub profile READMEs or full documentation-site authoring unless explicitly requested.

1 Updated 1 weeks ago
Shiaoming123
Code & Development Listed

rabbit-readme-improver

Draft a new README.md, or audit and improve an existing one, using patterns measured from 100 real, currently-trending GitHub repos rather than generic advice, and written in the user's own saved voice rather than a generated open-source register. Use when the user asks to write a README, create a project README, improve or clean up their README, review a README against best practices, add badges or a table of contents, restructure a README's sections, make a README look more professional, or make one sound like they wrote it. Covers new-project READMEs and edits to existing files.

0 Updated 2 weeks ago
whit3rabbit