ai-readme SKILL.md skillA
ai-readme from swyxio/skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add swyxio/skills/ai-readme@git:20260928.efe5ce6Pins git:20260928.efe5ce6 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- swyxio/skills
- Path
ai-readme/SKILL.md- Versions recorded
- 3
- Latest version
- git:20260928.efe5ce6, committed Sep 28, 2026
- First version recorded
- Aug 11, 2026
- Size
- 10,645 bytes
- Repository stars
- 194
- License
- MIT
Create or substantially revise repository README files that help a specific reader understand a technical project, reach a verified first result, and progress into realistic use, evaluation, debugging, or contribution. Use for project landing READMEs, CLI and library quickstarts, experimental or research repositories, executable engineering notebooks, and contributor-facing repository guides when an agent should reconstruct behavior from code, tests, commands, examples, and history rather than…
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
# AI README Write a repository-native explanation that earns trust by working. Lead with what the project is, who it helps, and the shortest verified path to an observable result. Then reveal the mechanism, tradeoffs, diagnostics, and internals at the reader's pace. Combine two complementary habits: - use an executable, progressive spine: one stable example, working commands, expected results, controlled variants, visible failure modes, and a reference path when correctness or quality can vary; - write like a public technical notebook: begin from a real task or curiosity, show the decisive artifact near the claim, explain what happened in ordinary language, preserve surprise and uncertainty, and stop when the reader's job is complete. Apply `swyx-writing` as the shared voice and editing layer. For substantial public README work, read its [technical-writer influences](../swyx-writing/references/technical-writer-influences.md). Apply `research-grounded-writing` when external claims or comparisons need support beyond the repository. ## Choose the README's job Identify the primary job before choosing sections: …
Read the whole file at its exact version.
How to install
mdr add swyxio/skills/ai-readme@sha256:4de87a154785e432The line at the top of this page pins the label git:20260928.efe5ce6, 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_d4ltew7mrko4lr67)
7 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 3 versions of this file, between Aug 11, 2026 and Sep 28, 2026, about one every 24 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260928.efe5ce6 latest | 2026-09-28 | efe5ce6 | 10,645 B | A | view · diff |
| git:20260912.6ee419c | 2026-09-12 | 6ee419c | 10,642 B | A | view · diff |
| git:20260811.3d7bb8e | 2026-08-11 | 3d7bb8e | 12,152 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 (10645 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
swyxio/skills · 194 stars · license MIT · pushed 2026-11-03 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_d4ltew7mrko4lr67 GET https://markdownregistry.com/api/v1/resolve?ref=swyxio/skills/ai-readme GET https://markdownregistry.com/api/v1/blob/4de87a154785e432227e3678e04eae2e745b3d13135880fdd450bc69b796d3d3
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.