readme SKILL.md skillA

readme from jasonm4130/claude-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add jasonm4130/claude-skills/readme@git:20261016.2eafc2c

Pins git:20261016.2eafc2c in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
jasonm4130/claude-skills
Path
plugins/writing-artifacts/skills/readme/SKILL.md
Versions recorded
1
Latest version
git:20261016.2eafc2c, committed Oct 16, 2026
Size
7,603 bytes
Repository stars
5
License
MIT

Use when writing, auditing or revising a project's README.md, including its badge row. Grounds every claim in a file:line fact inventory, scores the first screen, orders sections as a reader funnel, defines terms before use, keeps prose plain, and runs a checker for broken paths, links, anchors, commands, badges, emoji and leftover TODOs. Do NOT use for GitHub profile READMEs, API reference, CHANGELOGs or PR descriptions; writing-artifacts owns the sentence-level prose, and the adr skill owns…

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

A README is read by a stranger deciding, in about thirty seconds, whether this project is for them. Everything in it must be true of the repository as it stands today, and the first screen must answer the stranger's questions before it answers the maintainer's. This skill gives the procedure for getting there and a checker for the parts a script can verify. For sentence-level prose, apply `writing-artifacts:writing-artifacts` as well.

It applies to a new README, a rewrite, an audit of an existing one, or a README change inside a pull request. It does not decide what the project is, capture screenshots, or pick a license. When one of those is missing, say so and leave the decision to the owner.

## Stance

Say only what a reader could verify from the repository, and mark what you could not verify. A README that overclaims is worse than a short one: the reader trusts it once.

## Procedure

### 1. Read before writing
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add jasonm4130/claude-skills/readme@sha256:7ec4e684f864651c

The line at the top of this page pins the label git:20261016.2eafc2c, 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.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_xcts4tv475s4nkvf.svg)](https://markdownregistry.com/a/art_xcts4tv475s4nkvf)

1 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 1 version of this file, committed on Oct 16, 2026.

versioncommittedcommitsizeaudit
git:20261016.2eafc2c latest2026-10-16 2eafc2c 7,603 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (7603 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

GitHub

jasonm4130/claude-skills · 5 stars · license MIT · pushed 2026-10-18 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_xcts4tv475s4nkvf
GET https://markdownregistry.com/api/v1/resolve?ref=jasonm4130/claude-skills/readme
GET https://markdownregistry.com/api/v1/blob/7ec4e684f864651ce4127f621fa4f3f1d76bb8a140e4eb9d34fac7d1031b17fc

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 jasonm4130/claude-skills

codex-plan-review SKILL.md skill
jasonm4130/claude-skills · plugins/codex-review/skills/codex-plan-review/SKILL.md · Cross-provider adversarial review of a finalized plan, spec, design doc, ADR, or code diff using OpenAI Codex (GPT-6…
git:20260929.0b2c937 · audit A · 5 stars
domain-modeling SKILL.md skill
jasonm4130/claude-skills · plugins/domain-modeling/skills/domain-modeling/SKILL.md · Use when pinning down domain terminology, building a ubiquitous language or project glossary, disambiguating overloaded…
git:20260914.e17e16a · audit A · 5 stars
CLAUDE.md@plugins/gates CLAUDE.md file
jasonm4130/claude-skills · plugins/gates/CLAUDE.md
git:20261016.22838ed · audit A · 5 stars
docs-consolidate SKILL.md skill
jasonm4130/claude-skills · plugins/gates/skills/docs-consolidate/SKILL.md · Audit a repo's documentation for internal contradictions, stale claims, orphans and bloat after it has accumulated…
git:20260826.6b5d3b6 · audit A · 5 stars
CLAUDE.md@plugins/handoff CLAUDE.md file
jasonm4130/claude-skills · plugins/handoff/CLAUDE.md
git:20260826.13bf801 · audit A · 5 stars
handoff SKILL.md skill
jasonm4130/claude-skills · plugins/handoff/skills/handoff/SKILL.md · Write a structured handoff / resume document for this session so the next session can pick up exactly where this one…
git:20260830.df950a0 · audit A · 5 stars
writing-artifacts SKILL.md skill
jasonm4130/claude-skills · plugins/writing-artifacts/skills/writing-artifacts/SKILL.md · Use when writing or revising a durable written artifact — README, ADR, design doc, PR description, release notes…
git:20260830.df950a0 · audit A · 5 stars

Every file in jasonm4130/claude-skills

Other files named readme

readme SKILL.md skill
tushaarmehtaa/tushar-skills · plugins-labs/skills/readme/SKILL.md · Audit, write, and verify README files for adoption, operation, contribution, or internal orientation. Use when…
git:20261015.35cce77 · audit A · 12 stars
readme SKILL.md skill
tushaarmehtaa/tushar-skills · readme/SKILL.md · Audit, write, and verify README files for adoption, operation, contribution, or internal orientation. Use when…
git:20260807.fac9f85 · audit A · 12 stars
readme SKILL.md skill
0x0w1/jig · skills/readme/SKILL.md · Use when writing or updating a project README.md: scan the repository to classify the project type (CLI tool, library…
git:20260914.f91d23d · audit A · 5 stars
readme SKILL.md skill
0x0w1/jig · .claude/skills/readme/SKILL.md · Use when writing or updating a project README.md: scan the repository to classify the project type (CLI tool, library…
git:20260914.f91d23d · audit A · 5 stars

Browse by kind, by grade A, or by owner.