readme-standard SKILL.md skillA

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

Install it, pinned
mdr add openclaw/agent-skills/readme-standard@git:20260802.2a409d3

Pins git:20260802.2a409d3 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
openclaw/agent-skills
Path
skills/readme-standard/SKILL.md
Versions recorded
1
Latest version
git:20260802.2a409d3, committed Aug 2, 2026
Size
5,861 bytes
Repository stars
1,107
License
MIT

House README standard: structure, badge row, tone, per-archetype templates, and verification gates for steipete/openclaw repos.

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 Standard

One structure for every public README in the steipete and openclaw orgs. Load
this skill before writing or reviewing a README. The reference implementation
is [`openclaw/fs-safe`](https://github.com/openclaw/fs-safe) — read its README
first if unsure what "good" looks like.

## The spine

Every README answers, in order, with no detours:

1. **What is this?** — one sentence a stranger understands.
2. **How do I use it?** — smallest real install + a quickstart that *proves the pitch*.
3. **Progressively more complex** — each section assumes the previous one; deep
   reference material moves to `docs/` (or the docs site) and gets linked.

Concretely:

```
# <name> <one emoji> — <playful tagline, one line>

<badge row>

<1–2 sober sentences: what it is, who it is for. No adjectives doing the work
nouns should do.>

<OPTIONAL: one small code/terminal sample (≤10 lines) that demonstrates the
core value. If one sample can prove the pitch, put it here.>

## Install          ← smallest path first (brew/npm/npx), alternatives after
## Quick start      ← 60 seconds to first success; commands must actually run
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add openclaw/agent-skills/readme-standard@sha256:63eb153363169107

The line at the top of this page pins the label git:20260802.2a409d3, 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_ii3ttaubylzaav6v.svg)](https://markdownregistry.com/a/art_ii3ttaubylzaav6v)

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

Versions

The registry has recorded 1 version of this file, committed on Aug 2, 2026.

versioncommittedcommitsizeaudit
git:20260802.2a409d3 latest2026-08-02 2a409d3 5,861 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 (5861 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

openclaw/agent-skills · 1,107 stars · license MIT · pushed 2026-10-19 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_ii3ttaubylzaav6v
GET https://markdownregistry.com/api/v1/resolve?ref=openclaw/agent-skills/readme-standard
GET https://markdownregistry.com/api/v1/blob/63eb153363169107c328f2ab93666d1a6e01fba6f488e55023f78348e58e8ab4

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 openclaw/agent-skills

AGENTS.md AGENTS.md file
openclaw/agent-skills · AGENTS.md
git:20261006.0595f72 · audit A · 1,107 stars
agent-transcript SKILL.md skill
openclaw/agent-skills · skills/agent-transcript/SKILL.md · Requested GitHub PR/issue agent transcripts: redact, trim, preview, and insert safely.
git:20260912.fb5cc8f · audit A · 1,107 stars
AGENTS.md@skills/autoreview AGENTS.md file
openclaw/agent-skills · skills/autoreview/AGENTS.md
git:20261006.0595f72 · audit A · 1,107 stars
autoreview SKILL.md skill
openclaw/agent-skills · skills/autoreview/SKILL.md · Structured code review when explicitly requested, preferring OpenAI/Codex before Claude.
git:20261017.5569883 · audit A · 1,107 stars
beam SKILL.md skill
openclaw/agent-skills · skills/beam/SKILL.md · Publish a redacted local coding session to an authenticated read-only Beam catalog.
git:20260830.6cd3366 · audit A · 1,107 stars
behavior-validator SKILL.md skill
openclaw/agent-skills · skills/behavior-validator/SKILL.md · Source-blind user behavior validation against a prewritten contract for apps, CLIs, APIs, and generated artifacts.
git:20260701.2e86e90 · audit A · 1,107 stars
crabbox SKILL.md skill
openclaw/agent-skills · skills/crabbox/SKILL.md · Crabbox/Testbox remote proof: portable provider routing, untrusted isolation, Linux/macOS/Windows/WSL2, live E2E…
git:20261012.5e5cb6b · audit A · 1,107 stars
handoff SKILL.md skill
openclaw/agent-skills · skills/handoff/SKILL.md · Clipboard-ready handoff prompt for another agent to investigate or continue a task.
git:20260614.ca7ab87 · audit A · 1,107 stars
session-viewer SKILL.md skill
openclaw/agent-skills · skills/session-viewer/SKILL.md · Render Codex, Claude Code, OpenClaw, or Pi session JSONL transcripts as a searchable, shareable single-file HTML viewer.
git:20260912.e7c139f · audit A · 1,107 stars
team-handoff SKILL.md skill
openclaw/agent-skills · skills/team-handoff/SKILL.md · Hand local work to a shared OpenClaw Gateway: start a worktree session there as yourself in one request, seeded with a…
git:20261003.24fe6f4 · audit A · 1,107 stars

Every file in openclaw/agent-skills

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