readme-polish SKILL.md skillA
This file is byte-identical to the first copy the registry indexed, one of 3 indexed copies. Same content hash, so the same checks give both the same grade.
readme-polish from yzhao062/agent-config is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add yzhao062/agent-config/readme-polish@git:20260425.106e255Pins git:20260425.106e255 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- yzhao062/agent-config
- Path
skills/readme-polish/SKILL.md- Versions recorded
- 2
- Latest version
- git:20260425.106e255, committed Apr 25, 2026
- First version recorded
- Apr 16, 2026
- Size
- 14,755 bytes
- Repository stars
- 16
- License
- none declared
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.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# 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 …
Read the whole file at its exact version.
How to install
mdr add yzhao062/agent-config/readme-polish@sha256:dd1759441b63d4abThe line at the top of this page pins the label git:20260425.106e255, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_ko54hm42hufj44ol)
3 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 2 versions of this file, between Apr 16, 2026 and Apr 25, 2026, about one every 8 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260425.106e255 latest | 2026-04-25 | 106e255 | 14,755 B | A | view · diff |
| git:20260416.27a1704 | 2026-04-16 | 27a1704 | 9,092 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (14755 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
yzhao062/agent-config · 16 stars · license none declared · pushed 2026-10-23 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_ko54hm42hufj44ol GET https://markdownregistry.com/api/v1/resolve?ref=yzhao062/agent-config/readme-polish GET https://markdownregistry.com/api/v1/blob/dd1759441b63d4ab9b934814c6e493a3470ff14a1898e9380b60da54dc665f94
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.
More from yzhao062/agent-config
Every file in yzhao062/agent-config