readme SKILL.md skillB
readme from ephemerallycaden/write-readme is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add ephemerallycaden/write-readme/readme@git:20261028.c7f9f80Pins git:20261028.c7f9f80 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- B, 16 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- ephemerallycaden/write-readme
- Path
SKILL.md- Versions recorded
- 5
- Latest version
- git:20261028.c7f9f80, committed Oct 28, 2026
- First version recorded
- Oct 28, 2026
- Size
- 75,751 bytes
- Repository stars
- 5
- License
- MIT
Writes or improves a README (README.md) from codebase analysis, with run commands checked against build files, project screenshots and anti-AI writing rules. The prose avoids the patterns that make a README read as AI-generated. Use when asked to write, generate, create, update or rewrite a project README ("write a readme", "generate a README.md", "update my readme"), to critique, review, audit or improve an existing one ("/readme critique", "review my readme", "improve my readme"), or on…
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-readme write-readme writes a project's README.md from its codebase. It detects the project type (one of 20), asks at most three questions, puts install and run commands checked against the build files first, uses real screenshots (found in the repo, or captured with Playwright or VHS), and holds the prose to anti-AI writing rules. Run it with `/readme`; `/readme critique` audits an existing README, and `/readme architecture` writes an ARCHITECTURE.md. Generate a README.md by analyzing the current codebase, asking 0-3 questions, and producing a project-type-aware document that reads like a human wrote it. `<skill-dir>` in the commands below is this skill's base directory; `references/`, `scripts/`, and `skills/` paths are relative to it. …
Read the whole file at its exact version.
How to install
mdr add ephemerallycaden/write-readme/readme@sha256:22006471221f0a7eThe line at the top of this page pins the label git:20261028.c7f9f80, 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_c42b4on2r62vwycf)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 5 versions of this file, all committed on Oct 28, 2026. Its first recorded version is graded A and its latest B.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20261028.c7f9f80 latest | 2026-10-28 | c7f9f80 | 75,751 B | B | view · diff |
| git:20261028.2629cc7 | 2026-10-28 | 2629cc7 | 72,721 B | A | view · diff |
| git:20261028.82abf65 | 2026-10-28 | 82abf65 | 63,749 B | A | view · diff |
| git:20261028.995d746 | 2026-10-28 | 995d746 | 63,033 B | A | view · diff |
| git:20261028.c94a304 | 2026-10-28 | c94a304 | 65,840 B | A | view |
Audit of the latest version
- fail: No prompt-injection phrasing (matched: ignore previous instructions)
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (75751 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 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
Starting a new one? Use a template for SKILL.md on mdpantry, which passes every one of these checks and says what to change in it.
Source
ephemerallycaden/write-readme · 5 stars · license MIT · pushed 2026-10-29 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_c42b4on2r62vwycf GET https://markdownregistry.com/api/v1/resolve?ref=ephemerallycaden/write-readme/readme GET https://markdownregistry.com/api/v1/blob/22006471221f0a7ecba32bd83006de965b976dec60a91d2a6a65c127a5e0d28c
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 ephemerallycaden/write-readme
Every file in ephemerallycaden/write-readme