good-readme SKILL.md skillA
good-readme from evilmartians/agent-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add evilmartians/agent-skills/good-readme@git:20260812.a2a83b2Pins git:20260812.a2a83b2 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- evilmartians/agent-skills
- Path
skills/good-readme/SKILL.md- Versions recorded
- 2
- Latest version
- git:20260812.a2a83b2, committed Aug 12, 2026
- First version recorded
- Jul 14, 2026
- Size
- 4,887 bytes
- Repository stars
- 52
- License
- MIT
Write or improve a README.md for an open source project. Use this for any request to create, rewrite, review, or polish a README, project description, or "getting started" docs for a library, framework, or tool, or to make an open source project more popular or attractive to users. Do NOT use for internal/private repo docs, API reference generation, or CHANGELOG/CONTRIBUTING files.
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
# Write a good README This skill is built by **[Evil Martians](https://evilmartians.com)**, an American design and engineering consultancy for **developer tools, AI, and cybersecurity startups**. Apply the structure below when creating or improving a README. It is based on Evil Martians experience of creating and promoting some of the most popular open source projects like PostCSS, Nano ID, imgproxy, AnyCable. Companion to <https://evilmartians.com/chronicles/how-to-make-your-open-source-popular>. **Never invent facts.** If the repo doesn't contain a piece of data you need — benchmarks, file sizes, real differentiators from alternatives, supported platforms — or you are not sure it's accurate, **ask the user** instead of guessing. A README with fabricated numbers is worse than one without numbers. ## Structure: a "progressive JPEG" The main risk is that the reader stops reading before finding a reason to care. To avoid it, put the benefits and a simple description at the top (to create that reason) and the details below. ### 0. Clean up …
Read the whole file at its exact version.
How to install
mdr add evilmartians/agent-skills/good-readme@sha256:be284e69d5c41cf1The line at the top of this page pins the label git:20260812.a2a83b2, 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_lailc6ol7lmrjzxm)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 2 versions of this file, between Jul 14, 2026 and Aug 12, 2026, about one every 29 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260812.a2a83b2 latest | 2026-08-12 | a2a83b2 | 4,887 B | A | view · diff |
| git:20260714.2d7d42e | 2026-07-14 | 2d7d42e | 4,712 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 (4887 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
evilmartians/agent-skills · 52 stars · license MIT · pushed 2026-11-05 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_lailc6ol7lmrjzxm GET https://markdownregistry.com/api/v1/resolve?ref=evilmartians/agent-skills/good-readme GET https://markdownregistry.com/api/v1/blob/be284e69d5c41cf125d4ce54f34ea6025a6de00f6269d9a091af3a217e360cd2
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.