{"id":"901d654c-4ff4-42cb-ab3d-35c1b3068408","shortId":"5J5zac","kind":"skill","title":"readme-polish","tagline":"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 a","description":"# Readme Polish\n\n## Overview\n\nModern 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.\n\nThis 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.\n\n## When to Use\n\n- A README is a text wall with no visual anchors and no one can tell what the project does from a first glance.\n- An OSS release is about to ship and the README has not been pass-edited for discoverability.\n- The README mixes reference material with quickstart, so the install path is buried.\n- Publishing badges, adding a hero image, or restructuring sections would measurably help adoption.\n- 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.\n\n## When NOT to Use\n\n- The README already follows the patterns below and the content is fine. Do not thrash for style.\n- The project is internal / private / never published. No audience to optimize for.\n- The project needs documentation at site-level scale (tutorials, API reference, cookbook). README polish only covers the repo root; use Sphinx / MkDocs / Docusaurus for real docs sites.\n\n## Phase 1: Audit the current README\n\nBefore editing, classify what is there against the modern-README checklist. The goal is to identify which patterns are missing, which are misapplied, and which content should be moved, collapsed, or deleted.\n\nUse [`references/checklist.md`](references/checklist.md) as the audit grid. For each row, mark present / absent / broken.\n\nKey audit questions:\n\n1. **First-paint (above-the-fold)**: is the project name, one-line tagline, badges, and install command visible before the reader has to scroll? If not, content above those is displacing them.\n2. **Credentials placement**: is there a 100+ word maintainer bio blocking the first section? Move it into a `> [!NOTE]` callout or footnote.\n3. **Why-section shape**: if the README has a \"Why you'd use this\" or scenario block, are the items narrative (cause / effect, before / after) or feature-shaped? Narrative content reads warmer as bold-lead paragraphs; feature claims read cleaner as emoji-prefixed bullets. Pick one pattern per section.\n4. **Install path clarity**: can the reader find a single working install command in under 5 seconds? If not, there is probably too much pre-install framing.\n5. **Reference material above-the-fold**: are limitations, related projects, detailed repo layout, maintenance policy visible before install? They should be collapsed.\n6. **Visual anchors**: does the first screen have badges, a hero image, or a diagram? Without at least one, the README feels like documentation instead of a product page.\n7. **Examples block (What This Looks Like)**: does the README show what the project LOOKS LIKE in practice (screenshot, file tree, themed diagram, before / after, mock)? If yes, do 3+ examples each use a different visual format, or are three monospace blocks stacked in a row? The latter reads as a text wall regardless of content quality.\n8. **Themed Mermaid**: if Mermaid diagrams exist, do they use `%%{init: ...}%%` to match brand palette, or do they render with the default red/orange/blue and clash with the rest of the page?\n9. **Heading case**: is Title Case applied consistently across all H2 and H3? Sentence-case headings mixed with Title Case headings read as AI-generated or unedited (agent-style RULE-G).\n10. **Version-boundary honesty**: if a release ships primitives that are not yet wired, does the README name the boundary explicitly (what works today, what is queued), or does it present roadmap claims as shipped behavior?\n11. **Anchor hygiene**: do dot-nav links resolve to real sections (GitHub's auto-generated anchor rules: lowercase, hyphens for spaces, strip punctuation)?\n\n## Phase 2: Apply modern patterns\n\nSee [`references/patterns.md`](references/patterns.md) for the full catalog with copyable snippets. Summary of the highest-impact patterns:\n\n### Hero / first-paint\n- **Centered header** via `<div align=\"center\">`. Title, one-line tagline, badge row, dot-separated nav, one-liner elevator pitch.\n- **Shield.io badges** for package version (PyPI, npm), license, CI status, GitHub stars. Keep to 4-5; more than that becomes noise.\n- **Dot-separated nav links** (`[Install](#install) · [Workflow](#workflow) · [Features](#features)`) below badges. Helps skimmers jump.\n- **Hero image** — a PNG or SVG that makes a skimmer stop scrolling. Two paths:\n  - HTML mockup rendered via headless Chrome → PNG (good for feature grids, dashboards). See `ci-mockup-figure` skill for capture workflow.\n  - `<picture>` tag with light/dark variants for logos. Required only when the project has a logo/wordmark.\n- **Maintainer credibility** in a `> [!NOTE]` callout, not a prose paragraph. Ideal length: 2–3 sentences with verifiable signals (package stars, citations, institutional affiliation).\n\n### Content body\n- **GitHub alert callouts** for emphasis: `> [!NOTE]`, `> [!TIP]`, `> [!WARNING]`, `> [!CAUTION]`, `> [!IMPORTANT]`. Each renders as a colored box with an icon. Do not overuse — one per major section at most.\n- **Emoji-prefixed one-liner bullets** for \"What you get\" / \"Features\" when items are feature claims. Each bullet = 1 emoji + bolded feature name + one-line takeaway. 5–8 bullets is the sweet spot.\n- **Bold-lead scenario paragraphs** for \"Why you'd use this\" when items are narrative (cause / effect, before / after). Pattern: `**Bold lead sentence.** Setup. Without X, problem. With X, fix.` Reads warmer than emoji-bullet lists when content is story-shaped.\n- **\"What This Looks Like\" examples block** between How It Works and Install — 3 to 5 examples, each in a different visual format (screenshot / file tree / themed Mermaid / HTML 2-col before-after / terminal mock). The format-variety rule is the whole point; three monospace blocks in a row defeat it. See `patterns.md`.\n- **HTML 2-col `<table>` for rich before/after comparisons** — markdown tables cannot carry blockquotes, italic, or `<mark>` tags inside cells; HTML tables can. One per README is enough.\n- **Tables over dense bullets** for reference material (comparison, decision matrices, scenario → command). Tables read faster than bullets when the content is inherently tabular.\n- **Themed Mermaid** for architecture, flowcharts, and sequence diagrams — use the `%%{init: ...}%%` config block at the top to match brand palette. The default red / orange / blue clashes with most modern brand colors and reads as cookie-cutter. Do not use Mermaid as the hero image; it lacks the visual weight a polished mockup carries.\n- **Version-boundary honesty** as a content principle: when v0.4.0 ships primitives but the wiring is in v0.4.x, name the split explicitly. Roadmap claims belong in a \"What's Next\" section pointing at the changelog, not in the install / How It Works flow.\n- **Collapsible `<details>` blocks** for platform-specific variants, limitations, related projects, repo layout, FAQ, anything reference-shaped.\n- **Back-to-top anchor** (`<a name=\"readme-top\">` + `<a href=\"#readme-top\">↑ back to top</a>`) at the bottom of long READMEs.\n\n### Structure\n- **Above-the-fold (first ~40 lines)**: centered header → badges → nav → hero image → maintainer callout → tagline → elevator pitch.\n- **Middle**: quickstart + install, \"what you get\" bullets, optional \"why / philosophy\" narrative.\n- **Below**: day-to-day usage, contribution notes, limitations, related projects, license.\n- **Collapsed into `<details>`**: platform-specific install variants, repo layout, opinionated-and-why, limitations, related projects, maintenance policy.\n\n## Phase 3: Verify\n\nBefore publishing, verify the rewrite actually renders on GitHub (not just in PyCharm / VS Code preview).\n\n- [ ] Push to a branch and view on GitHub. GitHub-specific features that do **not** render in most local previews: `> [!NOTE]` callouts, Mermaid diagrams (themed and unthemed), `<picture>` light/dark media queries, autogenerated heading anchors for non-ASCII text, HTML `<table>` with markdown blockquotes inside cells.\n- [ ] Click every dot-nav link. Broken anchors are the most common bug introduced by rewrites.\n- [ ] Check the README at different viewport widths (desktop, narrow / mobile). Tables with long cells may overflow; hero images should be `width=\"100%\"` or responsive.\n- [ ] Confirm badges show live status (not a broken image). Shield.io URLs are case-sensitive for package names.\n- [ ] If the project has multiple surfaces (README + RTD landing + `README.zh-CN.md`), run a cross-surface drift pass. Tagline, How It Works structure, Pack-CLI claims, and What's Next paragraph should agree across surfaces. The `implement-review` skill handles this via \"Cross-variant drift check.\"\n- [ ] If any colored elements were customized (badge color, Mermaid theme, MkDocs CSS), verify WCAG AA contrast (≥ 4.5:1 for normal text against background) for both light and dark themes. Codex / Copilot reviews compute the ratios on request.\n- [ ] If the README references a rendered asset (PNG / GIF), verify the source file (HTML / tape) and the render helper (`_render_*.py` / `_render_*.sh`) are committed alongside it. Reproducibility matters for future rerenders; pinned Docker digests beat `:latest` tags.\n- [ ] Run `git diff --cached --check` before committing to catch trailing whitespace.\n\n## Common Pitfalls\n\n- **Over-badging.** More than 5-6 badges reads as clutter, not signal. Prioritize: package version, license, CI status, maybe stars or download count.\n- **Emoji overload.** Every section header with an emoji becomes noise. Reserve emoji for the one-liner feature bullets.\n- **Hero image that is just the logo.** A modern hero communicates what the project does (feature grid, animated demo, flowchart), not just the project name.\n- **Callout abuse.** If every third paragraph is `> [!NOTE]`, none of them stand out. Use callouts only for \"this is the one thing you must not miss\" moments.\n- **Collapsibles hiding the install command.** The install path must always be visible. Collapsibles are for reference material, not the critical path.\n- **Dot-nav pointing to missing anchors.** GitHub auto-generates anchors from heading text — lowercase, hyphens for spaces, strips most punctuation. Always verify post-rewrite.\n- **All-monospace examples in a row.** Tree + code block + terminal mock stacked together read as a text wall regardless of content quality. Vary the visual format across adjacent examples (PNG, ASCII tree, themed Mermaid, HTML 2-col, terminal mock).\n- **Narrative scenarios forced into feature bullets.** If each item needs setup, problem, and fix, use bold-lead paragraphs. Emoji bullets are for compact feature claims.\n- **Rich before/after squeezed into a markdown table.** Markdown tables cannot carry blockquotes, `<mark>`, or multi-paragraph commentary reliably. Use the HTML 2-col table pattern and keep blank lines inside each `<td>`.\n- **Multi-surface README drift.** README, RTD landing, and bilingual variants diverge unless they are reviewed as variant targets. Keep tagline, How It Works, Pack CLI, and What's Next aligned.\n- **Roadmap presented as today's behavior.** \"v0.4.0 ships X\" without naming what is queued for v0.4.x reads as overpromise to attentive readers and to Codex / Copilot reviewers. Mark version boundaries explicitly.\n- **Default Mermaid in a branded README.** Red error / orange warning / blue info clash with most modern brand colors. Add `%%{init: {'theme': 'base', 'themeVariables': {...}}}%%` at the top of every Mermaid block.\n- **Sentence-case headings mixed with Title Case.** Pick one and hold it across all H2 and H3. Sentence-case sub-headings inside a Title Case context (or vice versa) read as machine-generated. agent-style RULE-G says Title Case.\n- **Asset rendered once, source not committed.** Hero PNG without the HTML source, GIF without the vhs tape, banner PNG without the render helper — every rendered asset becomes brittle. Commit the source AND a `_render_*.py` / `_render_*.sh` helper alongside.\n- **PyCharm preview false confidence.** PyCharm's built-in markdown renderer does not render `> [!NOTE]`, Mermaid, `<picture>` media queries, or HTML `<table>` with markdown blockquotes inside cells. Only GitHub's renderer is authoritative.\n\n## Integration with Other Skills\n\n- **`ci-mockup-figure`** — use it to design and render the hero image when the README needs a custom feature-grid, architecture diagram, or pack-architecture pipeline. That skill handles the HTML-to-PNG capture workflow via Playwright.\n- **`implement-review`** — run a Codex review on the staged README rewrite before pushing. Lens: `general` / `docs`. Focus: first-read flow, anchor validity, content accuracy, version-boundary honesty, agent-style compliance, cross-surface drift if multi-surface. Plan on 2-4 review rounds for a substantial overhaul; expect findings to drop from High / Medium in early rounds to Low polish in late rounds.\n- **`agent-style`** — the writing rule pack governs the README prose: 21 rules total, 12 classic + 9 LLM-observed. RULE-G specifically governs Title Case across H2 / H3; RULE-B forbids casual em-dash; RULE-E forbids paragraph-closing summaries; RULE-F enforces consistent terms. Use the public [agent-style rule pack](https://github.com/yzhao062/agent-style/blob/main/docs/rule-pack.md) for the full reference and run a self-audit before requesting external review.\n\n## Output\n\nA rewritten `README.md` (and optional hero assets under `docs/`) that:\n- Reads cleanly in under 10 seconds for the tagline + install path\n- Has badges, dot-nav, hero image, at least one callout, and at least one collapsible\n- Keeps all prior content (moved or collapsed, not deleted) unless the content was stale or duplicated\n- Renders correctly on GitHub (the only renderer that matters)\n\nSee [`references/patterns.md`](references/patterns.md) for full pattern snippets and [`references/checklist.md`](references/checklist.md) for the audit grid.","tags":["readme","polish","anywhere","agents","yzhao062","agent-config","agent-skills","agents-md","ai-agents","ai-safety","claude-code","code-review"],"capabilities":["skill","source-yzhao062","skill-readme-polish","topic-agent-config","topic-agent-skills","topic-agents-md","topic-ai-agents","topic-ai-safety","topic-claude-code","topic-code-review","topic-codex","topic-dual-agent-review","topic-git-safety","topic-npm","topic-opinionated"],"categories":["anywhere-agents"],"synonyms":[],"warnings":[],"endpointUrl":"https://skills.sh/yzhao062/anywhere-agents/readme-polish","protocol":"skill","transport":"skills-sh","auth":{"type":"none","details":{"cli":"npx skills add yzhao062/anywhere-agents","source_repo":"https://github.com/yzhao062/anywhere-agents","install_from":"skills.sh"}},"qualityScore":"0.532","qualityRationale":"deterministic score 0.53 from registry signals: · indexed on github topic:agent-skills · 165 github stars · SKILL.md body (14,368 chars)","verified":false,"liveness":"unknown","lastLivenessCheck":null,"agentReviews":{"count":0,"score_avg":null,"cost_usd_avg":null,"success_rate":null,"latency_p50_ms":null,"narrative_summary":null,"summary_updated_at":null},"enrichmentModel":"deterministic:skill-github:v1","enrichmentVersion":1,"enrichedAt":"2026-05-02T06:54:59.111Z","embedding":null,"createdAt":"2026-04-18T22:16:09.233Z","updatedAt":"2026-05-02T06:54:59.111Z","lastSeenAt":"2026-05-02T06:54:59.111Z","tsv":"'-2026':14,116 '-4':2077 '-5':790 '-6':1545 '/yzhao062/agent-style/blob/main/docs/rule-pack.md)':2162 '1':300,355,933,1468 '10':44,77,668,2192 '100':396,1382 '11':705 '12':2114 '2':390,731,873,1020,1047,1718,1769,2076 '2025':13,115 '21':2111 '3':412,574,874,1004,1283 '4':465,789 '4.5':1467 '40':1228 '5':480,493,942,1006,1544 '6':516 '7':545 '8':602,943 '9':633,2116 'aa':1465 'above-the-fold':359,496,1223 'absent':350 'abus':1608 'accuraci':2057 'across':641,1436,1709,1884,2127 'actual':1290 'ad':202 'add':1859 'adjac':1710 'adopt':212 'affili':883 'agent':663,1909,2063,2101,2156 'agent-styl':662,1908,2062,2100,2155 'agre':1435 'ai':658 'ai-gener':657 'alert':22,887 'align':1809 'all-monospac':1682 'alongsid':1513,1955 'alreadi':244 'alway':1643,1677 'anchor':155,518,706,722,1212,1333,1352,1661,1666,2054 'anim':1599 'anyth':1204 'api':281 'appli':639,732 'architectur':1097,2013,2018 'ascii':1337,1713 'asset':1494,1917,1942,2184 'attent':237,1830 'audienc':267 'audit':4,301,343,353,2172,2252 'authorit':1986 'auto':720,1664 'auto-gener':719,1663 'autogener':1331 'b':2132 'back':1209,1213 'back-to-top':1208 'background':1473 'badg':18,201,371,524,764,776,808,1232,1386,1457,1541,1546,2200 'banner':1934 'base':1862 'beat':1523 'becom':794,1571,1943 'before-aft':1022 'before/after':1051,1749 'behavior':704,1815 'belong':1172 'bilingu':1788 'bio':399 'blank':100,1775 'block':400,429,547,586,997,1038,1106,1192,1691,1870 'blockquot':1057,1342,1759,1978 'blue':1118,1851 'bodi':885 'bold':448,935,950,969,1738 'bold-lead':447,949,1737 'bottom':1218 'boundari':671,688,1150,1839,2060 'box':901 'branch':1304 'brand':615,1112,1123,1845,1857 'brittl':1944 'broken':351,1351,1392 'bug':1357 'built':1963 'built-in':1962 'bullet':459,920,932,944,984,1074,1087,1247,1581,1727,1742 'buri':199 'cach':1529 'callout':23,409,866,888,1237,1322,1607,1621,2209 'cannot':1055,1757 'captur':845,2028 'carri':1056,1147,1758 'case':635,638,648,653,1398,1873,1878,1891,1898,1916,2126 'case-sensit':1397 'casual':2134 'catalog':741 'catch':1534 'caus':434,964 'caution':894 'cell':1062,1344,1374,1980 'center':16,756,1230 'changelog':1182 'check':1361,1450,1530 'checklist':316 'chrome':831 'ci':783,840,1556,1992 'ci-mockup-figur':839,1991 'citat':881 'claim':452,701,930,1171,1428,1747 'clariti':468 'clash':626,1119,1853 'classic':2115 'classifi':307 'clean':2189 'cleaner':454 'cli':1427,1804 'click':1345 'close':2144 'clutter':1549 'code':1299,1690 'codex':1480,1834,2037 'col':1021,1048,1719,1770 'collaps':85,335,515,1191,1264,1634,1646,2214,2221 'color':900,1124,1453,1458,1858 'come':131 'command':374,477,1082,1638 'commentari':1764 'commit':1512,1532,1922,1945 'common':1356,1537 'communic':1592 'compact':1745 'comparison':1052,1078 'compet':235 'complianc':2065 'comput':1483 'confid':1959 'config':1105 'confirm':1385 'consist':640,2150 'content':129,130,140,251,331,384,443,600,884,987,1090,1154,1703,2056,2218,2226 'context':1899 'contrast':1466 'contribut':1258 'converg':122 'convey':222 'cookbook':283 'cooki':1129 'cookie-cutt':1128 'copilot':1481,1835 'copyabl':743 'correct':2232 'count':1562 'cover':287 'credenti':391 'credibl':217,862 'critic':1653 'cross':1416,1447,2067 'cross-surfac':1415,2066 'cross-vari':1446 'css':1462 'current':303 'custom':1456,2009 'cutter':1130 'd':424,957 'dark':1478 'dash':2137 'dashboard':837 'day':1254,1256 'day-to-day':1253 'decis':1079 'default':623,1115,1841 'defeat':1042 'delet':337,2223 'demo':1600 'dens':34,1073 'design':1998 'desktop':1368 'detail':29,83,504 'diagram':31,530,567,607,1101,1324,2014 'diff':1528 'differ':579,1011,1365 'digest':1522 'discover':186 'displac':388 'diverg':1790 'doc':297,2048,2186 'docker':1521 'document':274,539 'docusaurus':294 'dot':710,767,797,1348,1656,2202 'dot-nav':709,1347,1655,2201 'dot-separ':766,796 'download':1561 'drift':1418,1449,1783,2069 'drop':2087 'duplic':2230 'e':2140 'earli':2092 'edit':184,306 'effect':435,965 'element':1454 'elev':773,1239 'em':2136 'em-dash':2135 'emoji':25,457,915,934,983,1563,1570,1574,1741 'emoji-bullet':982 'emoji-prefix':24,456,914 'emphasi':890 'enforc':2149 'enough':1070 'error':1848 'everi':1346,1565,1610,1868,1940 'exampl':546,575,996,1007,1685,1711 'exist':96,608 'expand':28 'expect':2084 'explicit':689,1169,1840 'extern':2175 'f':2148 'fals':1958 'faq':1203 'faster':1085 'featur':27,440,451,805,806,835,925,929,936,1312,1580,1597,1726,1746,2011 'feature-grid':2010 'feature-shap':439 'feel':537 'figur':842,1994 'file':564,1015,1500 'find':472,2085 'fine':253 'first':56,167,357,402,521,754,1227,2051 'first-paint':356,753 'first-read':2050 'fix':978,1735 'flow':1190,2053 'flowchart':1098,1601 'focus':2049 'fold':362,499,1226 'follow':89,245 'follow-up':88 'footnot':411 'forbid':2133,2141 'forc':1724 'format':581,1013,1029,1708 'format-varieti':1028 'frame':492 'full':740,2165,2244 'futur':1518 'g':667,1913,2122 'general':2047 'generat':659,721,1665,1907 'get':81,924,1246 'gif':1496,1929 'git':1527 'github':6,21,52,717,785,886,1293,1308,1310,1662,1982,2234 'github-specif':1309 'github.com':2161 'github.com/yzhao062/agent-style/blob/main/docs/rule-pack.md)':2160 'glanc':168 'goal':318 'good':833 'govern':2107,2124 'grid':344,836,1598,2012,2253 'h2':643,1886,2128 'h3':645,1888,2129 'handl':1443,2022 'head':634,649,654,1332,1668,1874,1894 'header':17,757,1231,1567 'headless':830 'help':211,809 'helper':1506,1939,1954 'hero':19,204,526,752,812,1137,1234,1377,1582,1591,1923,2002,2183,2204 'hide':1635 'high':2089 'highest':749 'highest-impact':748 'hold':1882 'honesti':672,1151,2061 'html':826,1019,1046,1063,1339,1501,1717,1768,1927,1975,2025 'html-to-png':2024 'hygien':707 'hyphen':725,1671 'icon':904 'ideal':871 'identifi':321 'imag':20,205,527,813,1138,1235,1378,1393,1583,2003,2205 'impact':750 'implement':1440,2033 'implement-review':1439,2032 'import':895 'info':1852 'inher':1092 'init':612,1104,1860 'insid':1061,1343,1777,1895,1979 'instal':74,196,373,466,476,491,511,801,802,1003,1186,1243,1269,1637,1640,2197 'instead':540 'institut':882 'integr':1987 'intern':262 'introduc':1358 'invent':127 'ital':1058 'item':432,927,961,1730 'jump':811 'keep':787,1774,1798,2215 'key':352 'lack':1140 'land':1411,1786 'late':2098 'latest':1524 'latter':592 'layout':109,506,1202,1272 'lead':449,951,970,1739 'least':533,2207,2212 'legit':226 'len':2046 'length':872 'level':278 'licens':782,1263,1555 'light':1476 'light/dark':849,1328 'like':538,551,560,995 'limit':501,1198,1260,1277 'line':369,762,940,1229,1776 'liner':772,919,1579 'link':712,800,1350 'list':985 'live':1388 'llm':2118 'llm-observ':2117 'local':1319 'logo':852,1588 'logo/wordmark':860 'long':1220,1373 'look':550,559,994 'low':2095 'lowercas':724,1670 'machin':1906 'machine-gener':1905 'maintain':398,861,1236 'mainten':507,1280 'major':910 'make':819 'mark':348,1837 'markdown':1053,1341,1753,1755,1965,1977 'match':614,1111 'materi':191,495,1077,1650 'matric':1080 'matter':1516,2239 'may':1375 'mayb':1558 'measur':210 'media':1329,1972 'medium':2090 'mermaid':30,604,606,1018,1095,1134,1323,1459,1716,1842,1869,1971 'middl':1241 'misappli':328 'miss':325,1632,1660 'mix':189,650,1875 'mkdoc':293,1461 'mobil':1370 'mock':570,1026,1693,1721 'mockup':827,841,1146,1993 'modern':12,51,314,733,1122,1590,1856 'modern-readm':313 'moment':1633 'monospac':585,1037,1684 'motiv':79 'move':334,404,2219 'much':488 'multi':1762,1780,2072 'multi-paragraph':1761 'multi-surfac':1779,2071 'multipl':1407 'must':1630,1642 'name':366,686,937,1166,1402,1606,1820 'narrat':433,442,963,1251,1722 'narrow':1369 'nav':711,769,799,1233,1349,1657,2203 'need':273,1731,2007 'never':264 'next':1177,1432,1808 'nois':795,1572 'non':1336 'non-ascii':1335 'none':1615 'normal':1470 'note':408,865,891,1259,1321,1614,1970 'npm':781 'observ':2119 'one':158,368,461,534,761,771,908,918,939,1066,1578,1627,1880,2208,2213 'one-lin':367,760,770,917,938,1577 'open':118 'open-sourc':117 'opinion':1274 'opinionated-and-whi':1273 'optim':269 'option':1248,2182 'orang':1117,1849 'oss':170 'output':2177 'over-badg':1539 'overflow':1376 'overhaul':2083 'overload':1564 'overpromis':1828 'overus':907 'overview':50 'pack':1426,1803,2017,2106,2159 'pack-architectur':2016 'pack-c':1425 'packag':778,879,1401,1553 'page':544,632 'paint':358,755 'palett':616,1113 'paragraph':450,870,953,1433,1612,1740,1763,2143 'paragraph-clos':2142 'pass':183,1419 'pass-edit':182 'path':197,467,825,1641,1654,2198 'pattern':15,110,247,323,462,734,751,968,1772,2245 'patterns.md':1045 'per':463,909,1067 'phase':299,730,1282 'philosophi':1250 'pick':460,1879 'pin':1520 'pipelin':2019 'pitch':774,1240 'pitfal':1538 'placement':392 'plan':2074 'platform':1195,1267 'platform-specif':1194,1266 'playwright':2031 'png':815,832,1495,1712,1924,1935,2027 'point':1035,1179,1658 'polici':508,1281 'polish':3,49,285,1145,2096 'post':1680 'post-rewrit':1679 'practic':562 'practition':214 'pre':490 'pre-instal':489 'prefix':26,458,916 'present':142,349,699,1811 'preview':1300,1320,1957 'primit':677,1159 'principl':1155 'prior':2217 'priorit':1552 'privat':263 'probabl':486 'problem':975,1733 'produc':36 'product':543 'project':65,120,134,163,260,272,365,503,558,857,1200,1262,1279,1405,1595,1605 'prose':35,869,2110 'public':2154 'publish':200,265,1286 'punctuat':729,1676 'push':1301,2045 'py':1508,1951 'pycharm':1297,1956,1960 'pypi':780 'qualiti':601,1704 'queri':1330,1973 'question':354 'queu':695,1823 'quickstart':193,1242 'ratio':1485 'read':444,453,593,655,979,1084,1126,1547,1696,1826,1903,2052,2188 'readabl':57 'reader':80,378,471,1831 'readm':2,7,39,48,53,97,147,178,188,220,243,284,304,315,419,536,554,685,1068,1221,1363,1409,1490,1782,1784,1846,2006,2042,2109 'readme-polish':1 'readme.md':2180 'readme.zh-cn.md':1412 'real':296,715 'red':1116,1847 'red/orange/blue':624 'refer':190,282,494,1076,1206,1491,1649,2166 'reference-shap':1205 'references/checklist.md':339,340,2248,2249 'references/patterns.md':736,737,2241,2242 'regard':114 'regardless':598,1701 'relat':502,1199,1261,1278 'releas':171,675 'reliabl':1765 'render':620,828,897,1291,1316,1493,1505,1507,1509,1918,1938,1941,1950,1952,1966,1969,1984,2000,2231,2237 'repo':289,505,1201,1271 'reproduc':1515 'request':1487,2174 'requir':853 'rerend':1519 'reserv':1573 'resolv':713 'respons':1384 'rest':629 'restructur':207 'review':1441,1482,1794,1836,2034,2038,2078,2176 'rewrit':9,103,1289,1360,1681,2043 'rewritten':2179 'rich':1050,1748 'roadmap':700,1170,1810 'root':290 'round':2079,2093,2099 'row':347,590,765,1041,1688 'rtd':1410,1785 'rule':666,723,1031,1912,2105,2112,2121,2131,2139,2147,2158 'rule-':2138 'rule-b':2130 'rule-f':2146 'rule-g':665,1911,2120 'run':1413,1526,2035,2168 'say':1914 'scale':279 'scannabl':38,55 'scenario':428,952,1081,1723 'screen':522 'screenshot':563,1014 'scroll':381,823 'second':45,58,78,481,2193 'section':91,208,403,415,464,716,911,1178,1566 'see':735,838,1044,2240 'self':2171 'self-audit':2170 'sensit':1399 'sentenc':647,875,971,1872,1890 'sentence-cas':646,1871,1889 'separ':768,798 'sequenc':1100 'setup':972,1732 'sh':1510,1953 'shape':137,416,441,991,1207 'shield.io':775,1394 'ship':175,676,703,1158,1817 'show':555,1387 'signal':878,1551 'singl':474 'site':277,298 'site-level':276 'skill':93,843,1442,1990,2021 'skill-readme-polish' 'skim':46 'skimmer':60,810,821 'slate':101 'snippet':744,2246 'social':216 'sourc':119,1499,1920,1928,1947 'source-yzhao062' 'space':727,1673 'specif':1196,1268,1311,2123 'sphinx':292 'split':1168 'spot':948 'squeez':1750 'stack':587,1694 'stage':2041 'stale':2228 'stand':1618 'star':786,880,1559 'status':784,1389,1557 'stop':822 'stori':990 'story-shap':989 'strip':728,1674 'structur':1222,1424 'style':258,664,1910,2064,2102,2157 'sub':1893 'sub-head':1892 'substanti':2082 'summari':745,2145 'surfac':1408,1417,1437,1781,2068,2073 'svg':817 'sweet':947 'tabl':32,86,1054,1064,1071,1083,1371,1754,1756,1771 'tabular':1093 'tag':847,1060,1525 'taglin':370,763,1238,1420,1799,2196 'take':94 'takeaway':941 'tape':1502,1933 'target':1797 'tell':160 'term':2151 'termin':1025,1692,1720 'text':150,596,1338,1471,1669,1699 'theme':566,603,1017,1094,1325,1460,1479,1715,1861 'themevari':1863 'thing':1628 'third':1611 'thrash':256 'three':584,1036 'tip':892 'titl':637,652,759,1877,1897,1915,2125 'today':692,1813 'togeth':1695 'top':1109,1211,1215,1866 'topic-agent-config' 'topic-agent-skills' 'topic-agents-md' 'topic-ai-agents' 'topic-ai-safety' 'topic-claude-code' 'topic-code-review' 'topic-codex' 'topic-dual-agent-review' 'topic-git-safety' 'topic-npm' 'topic-opinionated' 'total':2113 'trail':1535 'tree':565,1016,1689,1714 'tutori':280 'two':824 'understand':62 'unedit':661 'unless':1791,2224 'unthem':1327 'url':1395 'usag':1257 'use':11,105,145,232,241,291,338,425,577,611,958,1102,1133,1620,1736,1766,1995,2152 'v0.4.0':1157,1816 'v0.4.x':1165,1825 'valid':2055 'vari':1705 'variant':850,1197,1270,1448,1789,1796 'varieti':1030 'verifi':877,1284,1287,1463,1497,1678 'versa':1902 'version':670,779,1149,1554,1838,2059 'version-boundari':669,1148,2058 'vhs':1932 'via':758,829,1445,2030 'vice':1901 'view':1306 'viewport':1366 'visibl':375,509,1645 'visual':107,154,517,580,1012,1142,1707 'vs':1298 'wall':151,597,1700 'want':218 'warmer':445,980 'warn':893,1850 'wcag':1464 'weight':1143 'well':113 'well-regard':112 'whitespac':1536 'whole':1034 'why-sect':413 'width':1367,1381 'wire':682,1162 'without':234,531,973,1819,1925,1930,1936 'word':397 'work':41,475,691,1001,1189,1423,1802 'workflow':803,804,846,2029 'would':209 'write':2104 'x':974,977,1818 'yes':572 'yet':681","prices":[{"id":"a5163bfb-13a2-4302-9112-a4f171820703","listingId":"901d654c-4ff4-42cb-ab3d-35c1b3068408","amountUsd":"0","unit":"free","nativeCurrency":null,"nativeAmount":null,"chain":null,"payTo":null,"paymentMethod":"skill-free","isPrimary":true,"details":{"org":"yzhao062","category":"anywhere-agents","install_from":"skills.sh"},"createdAt":"2026-04-18T22:16:09.233Z"}],"sources":[{"listingId":"901d654c-4ff4-42cb-ab3d-35c1b3068408","source":"github","sourceId":"yzhao062/anywhere-agents/readme-polish","sourceUrl":"https://github.com/yzhao062/anywhere-agents/tree/main/skills/readme-polish","isPrimary":false,"firstSeenAt":"2026-04-18T22:16:09.233Z","lastSeenAt":"2026-05-02T06:54:59.111Z"}],"details":{"listingId":"901d654c-4ff4-42cb-ab3d-35c1b3068408","quickStartSnippet":null,"exampleRequest":null,"exampleResponse":null,"schema":null,"openapiUrl":null,"agentsTxtUrl":null,"citations":[],"useCases":[],"bestFor":[],"notFor":[],"kindDetails":{"org":"yzhao062","slug":"readme-polish","github":{"repo":"yzhao062/anywhere-agents","stars":165,"topics":["agent-config","agent-skills","agents-md","ai-agents","ai-safety","claude-code","code-review","codex","dual-agent-review","git-safety","npm","opinionated","portable-config","pypi","safety-hooks","shared-configuration","skill-dispatch","skill-router"],"license":"apache-2.0","html_url":"https://github.com/yzhao062/anywhere-agents","pushed_at":"2026-05-01T06:48:52Z","description":"One config to rule all your AI agents: portable (every project, every session), effective (curated writing, routing, skills), and safer (destructive-command guard).","skill_md_sha":"2756d1187ff8157df03d0b0dd18a8d19bd3cf72b","skill_md_path":"skills/readme-polish/SKILL.md","default_branch":"main","skill_tree_url":"https://github.com/yzhao062/anywhere-agents/tree/main/skills/readme-polish"},"layout":"multi","source":"github","category":"anywhere-agents","frontmatter":{"name":"readme-polish","description":"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."},"skills_sh_url":"https://skills.sh/yzhao062/anywhere-agents/readme-polish"},"updatedAt":"2026-05-02T06:54:59.111Z"}}