readme-optimization SKILL.md skillA
readme-optimization from samber/developer-relations-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add samber/developer-relations-skills/readme-optimization@v1.0.3Pins v1.0.3 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- samber/developer-relations-skills
- Path
skills/readme-optimization/SKILL.md- Versions recorded
- 5
- Latest version
- v1.0.3, committed Oct 25, 2026
- First version recorded
- Sep 27, 2026
- Size
- 28,876 bytes
- Repository stars
- 8
- License
- MIT
Audits and rewrites a repository README so a developer who has never seen the project can tell what it is, why it beats the alternative, and run the first command inside a minute - every claim and the documented install verified against the source, the page ordered into a bail-fast funnel, badges that earn nothing pruned. Use whenever someone says "review my README", "my readme is bad", "write a README for this repo", "nobody understands what my project does", "repo first impression…
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 Optimization You are working on the single page that decides whether a developer tries a project or closes the tab. Diagnose the existing README against evidence, then rewrite it so a stranger can evaluate the project quickly and accurately - including deciding _not_ to use it, which is a correct outcome you should never optimize away. A README is not a documentation type. It is a landing page and a router: it answers what and why in seconds, then sends the reader onward. Judge it on whether it converts a visitor into a trial, not on documentation completeness. Put the rewrite budget where the scarcity is. Across 393 sampled GitHub repositories (Prana et al. 2019, cited in [./references/published-findings.md](./references/published-findings.md); the sample is late-2010s, read it as a baseline, not a census): - What the project is: 97.0% - table stakes. - How to use it: 88.5% - table stakes. - Why to pick it over the alternatives: 25.7% - scarce. - What state the project is in: 21.4% - scarce. Those two scarce categories are exactly what an evaluating developer must answer before adopting anything. …
Read the whole file at its exact version.
How to install
mdr add samber/developer-relations-skills/readme-optimization@sha256:95908c867f78f67cThe line at the top of this page pins the label v1.0.3, 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_c2lqcpkqs432wuj2)
1 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 5 versions of this file, between Sep 27, 2026 and Oct 25, 2026, about one every 7 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| v1.0.3 latest | 2026-10-25 | 2c2141c | 28,876 B | A | view · diff |
| v1.0.2 | 2026-10-22 | f94b659 | 28,774 B | A | view · diff |
| v1.0.1 | 2026-10-21 | 282f06c | 28,772 B | A | view · diff |
| v1.0.1 | 2026-10-20 | d3f59d6 | 28,606 B | A | view · diff |
| v1.0.1 | 2026-09-27 | bc8ac6d | 28,463 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 (28876 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
samber/developer-relations-skills · 8 stars · license MIT · pushed 2026-11-01 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_c2lqcpkqs432wuj2 GET https://markdownregistry.com/api/v1/resolve?ref=samber/developer-relations-skills/readme-optimization GET https://markdownregistry.com/api/v1/blob/95908c867f78f67cf33038bb1b488e3cb725e1a86d2603b60a93c8df803d149e
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.