- name
SKILL.md
The skill file stays in the publisher's repository.
Paste the copied command in a terminal. It installs this SKILL.md into that agent.
npx skills add yzhao062/anywhere-agents --skill readme-polish -a cursor -yPaste the copied command in a terminal. It installs this SKILL.md into that agent.
npx skills add yzhao062/anywhere-agents --skill readme-polish -a claude-code -yPaste the copied command in a terminal. It installs this SKILL.md into that agent.
npx skills add yzhao062/anywhere-agents --skill readme-polish -a codex -yPaste the copied command in a terminal. It installs this SKILL.md into that agent.
npx skills add yzhao062/anywhere-agents --skill readme-polish -a grok -ySend the copied message in a Grok Bot chat. The Bot fetches this SKILL.md from GitHub and adds it to the skills all your Bots share.
Install this skill: https://github.com/yzhao062/anywhere-agents/tree/HEAD/packages/pypi/anywhere_agents/composer/skills/readme-polishFrom the publisher
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.
Before 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.
Use references/checklist.md as the audit grid. For each row, mark present / absent / broken.
Key audit questions:
> [!NOTE] callout or footnote.%%{init: ...}%% to match brand palette, or do they render with the default red/orange/blue and clash with the rest of the page?See references/patterns.md for the full catalog with copyable snippets. Summary of the highest-impact patterns:
<div align="center">. Title, one-line tagline, badge row, dot-separated nav, one-liner elevator pitch.[Install](#install) · [Workflow](#workflow) · [Features](#features)) below badges. Helps skimmers jump.ci-mockup-figure skill for capture workflow.<picture> tag with light/dark variants for logos. Required only when the project has a logo/wordmark.> [!NOTE] callout, not a prose paragraph. Ideal length: 2–3 sentences with verifiable signals (package stars, citations, institutional affiliation).> [!NOTE], > [!TIP], > [!WARNING], > [!CAUTION], > [!IMPORTANT]. Each renders as a colored box with an icon. Do not overuse — one per major section at most.**Bold lead sentence.** Setup. Without X, problem. With X, fix. Reads warmer than emoji-bullet lists when content is story-shaped.patterns.md.<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.%%{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.<details> blocks for platform-specific variants, limitations, related projects, repo layout, FAQ, anything reference-shaped.<a name="readme-top"> + <a href="#readme-top">↑ back to top</a>) at the bottom of long READMEs.<details>: platform-specific install variants, repo layout, opinionated-and-why, limitations, related projects, maintenance policy.Before publishing, verify the rewrite actually renders on GitHub (not just in PyCharm / VS Code preview).
> [!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.width="100%" or responsive.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."_render_*.py / _render_*.sh) are committed alongside it. Reproducibility matters for future rerenders; pinned Docker digests beat :latest tags.git diff --cached --check before committing to catch trailing whitespace.> [!NOTE], none of them stand out. Use callouts only for "this is the one thing you must not miss" moments.<mark>, or multi-paragraph commentary reliably. Use the HTML 2-col table pattern and keep blank lines inside each <td>.%%{init: {'theme': 'base', 'themeVariables': {...}}}%% at the top of every Mermaid block.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.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.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 for the full reference and run a self-audit before requesting external review.A rewritten README.md (and optional hero assets under docs/) that:
See references/patterns.md for full pattern snippets and references/checklist.md for the audit grid.
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
---name: readme-polishdescription: Audit a GitHub README and rewrite it using modern 2025-2026 patterns — centered header, badges, hero image…---# packages/pypi/anywhere_agents/composer/skills/readme-polish/SKILL.mdOverview
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.
FAQ
Download packages/pypi/anywhere_agents/composer/skills/readme-polish/SKILL.md from the publisher, or copy the path and open the repository. PlugMCP lists the skill and does not host the file.
The publisher keeps it at https://github.com/yzhao062/anywhere-agents.
Claude, Cursor, Codex, and Grok Build can read a SKILL.md you add from the publisher's repository. Grok Bot installs it when you send the skill's GitHub folder link in a chat.
_render_*.py_render_*.sh> [!NOTE], Mermaid, <picture> media queries, or HTML <table> with markdown blockquotes inside cells. Only GitHub's renderer is authoritative.