write-readme SKILL.md skillB

write-readme from urmzd/dotfiles is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add urmzd/dotfiles/write-readme@git:20261029.73191d5

Pins git:20261029.73191d5 in mdr.lock. Pin the fingerprint instead.

Audit grade
B, 16 of 17 checks passed
Kind
SKILL.md skill
Repository
urmzd/dotfiles
Path
dot_agents/skills/write-readme/SKILL.md
Versions recorded
5
Latest version
git:20261029.73191d5, committed Oct 29, 2026
First version recorded
Apr 19, 2026
Size
11,135 bytes
Repository stars
5
License
Apache-2.0

Structures and writes a project README: centered header, badges, demo image, section order, install.sh one-liner, Quick Start, fsrc code embeds, and the Agent Skill section. Use when creating or updating any project's README.md. Do NOT use for AGENTS.md or the skills-vs-docs taxonomy -> use configure-ai (configure-ai owns AGENTS.md and the docs taxonomy; write-readme owns README structure). For llms.txt generation -> use create-llms-txt.

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 Standards

## Centered Header Template

Every README starts with a centered header block:

```html
<p align="center">
  <h1 align="center">{Display Name}</h1>
  <p align="center">
    {One-line description}
    <br /><br />
    <a href="...releases">Download</a>
    &middot;
    <a href="...issues">Report Bug</a>
    &middot;
    <a href="{url}">{Third Link}</a>
  </p>
</p>
```

- Link 1: "Install" for libraries (Go `go get`, Python `uv add`), "Download" for binaries
- Link 2: "Report Bug" (always links to `/issues`)
- Link 3: **contextual** Go Docs, GitHub Action, PyPI, Crates.io, Experiments, etc.

## Badges

Centered, immediately below header. Use exactly the set that applies; no more, no less. Maximum **four** badges.

| Badge | When | Template |
|-------|------|----------|
| CI | always | `![CI](https://github.com/{owner}/{repo}/actions/workflows/ci.yml/badge.svg)` |
| License | always | `![License](https://img.shields.io/github/license/{owner}/{repo})` |
| Registry | published libraries only | crates.io / npm / PyPI / pkg.go.dev shield |
| Release | projects with downloadable binaries | `![Release](https://img.shields.io/github/v/release/{owner}/{repo})` |
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add urmzd/dotfiles/write-readme@sha256:c83c97fe9bff5978

The line at the top of this page pins the label git:20261029.73191d5, 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_jxxzqd62xlwmbras.svg)](https://markdownregistry.com/a/art_jxxzqd62xlwmbras)

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

Versions

The registry has recorded 5 versions of this file, between Apr 19, 2026 and Oct 29, 2026, about one every 48 days.

versioncommittedcommitsizeaudit
git:20261029.73191d5 latest2026-10-29 73191d5 11,135 BB view · diff
git:20261027.9b821b02026-10-27 9b821b0 11,220 BB view · diff
git:20260712.ae7b7ce2026-07-12 ae7b7ce 10,608 BB view · diff
git:20260530.d3be4dd2026-05-30 d3be4dd 10,608 BB view · diff
git:20260419.c6fa57e2026-04-19 c6fa57e 10,313 BB view

Audit of the latest version

B  16 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • fail: No curl or wget piped into a shell (matched: curl | sh)
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (11135 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 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

GitHub

urmzd/dotfiles · 5 stars · license Apache-2.0 · pushed 2026-11-03 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_jxxzqd62xlwmbras
GET https://markdownregistry.com/api/v1/resolve?ref=urmzd/dotfiles/write-readme
GET https://markdownregistry.com/api/v1/blob/c83c97fe9bff5978667e069dc6ea68db925772d97544fc815e2c8221cc527248

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 urmzd/dotfiles

AGENTS.md AGENTS.md file
urmzd/dotfiles · AGENTS.md
git:20261029.87faea9 · audit B · 5 stars
AGENTS.md@dot_agents AGENTS.md file
urmzd/dotfiles · dot_agents/AGENTS.md
git:20260530.1caba92 · audit A · 5 stars
agent-design-doctrine SKILL.md skill
urmzd/dotfiles · dot_agents/skills/agent-design-doctrine/SKILL.md · House doctrine for designing LLM agent systems: safety enforced by the harness and tools rather than model goodwill…
git:20260717.aa74bbe · audit A · 5 stars
align-readmes SKILL.md skill
urmzd/dotfiles · dot_agents/skills/align-readmes/SKILL.md · Audit and converge README.md across every local urmzd/* checkout so the fleet reads as one product: skip archived…
git:20261020.f6dc06f · audit A · 5 stars
asd-ste100 SKILL.md skill
urmzd/dotfiles · dot_agents/skills/asd-ste100/SKILL.md · Write or rewrite text in ASD-STE100 Simplified Technical English (STE): the approved-word dictionary discipline…
git:20260724.55c8372 · audit A · 5 stars
assess-quality SKILL.md skill
urmzd/dotfiles · dot_agents/skills/assess-quality/SKILL.md · Foundational quality framework: the five questions (readable, easy to start, expands without bloat, consistent…
git:20261029.73191d5 · audit A · 5 stars
audit-security SKILL.md skill
urmzd/dotfiles · dot_agents/skills/audit-security/SKILL.md · Scans a repo and host for leaked keys and secrets (gitleaks, trufflehog), audits SSH/GPG/.env file permissions, checks…
git:20260530.d3be4dd · audit A · 5 stars
build-cli SKILL.md skill
urmzd/dotfiles · dot_agents/skills/build-cli/SKILL.md · Design and audit CLI tools end-to-end: output modes, TTY detection, JSON piping, stderr/stdout separation, color/symbol…
git:20260530.d3be4dd · audit B · 5 stars
check-project SKILL.md skill
urmzd/dotfiles · dot_agents/skills/check-project/SKILL.md · Validate project structure against scaffold conventions -- check for required files, CI consistency, documentation…
git:20261030.540b71f · audit A · 5 stars
choose-stack SKILL.md skill
urmzd/dotfiles · dot_agents/skills/choose-stack/SKILL.md · Canonical tech-stack reference organized by purpose: release/versioning (sr), docs/demos (teasr, fsrc), codegen (oag)…
git:20260530.d3be4dd · audit A · 5 stars
clean-docs SKILL.md skill
urmzd/dotfiles · dot_agents/skills/clean-docs/SKILL.md · Clean and modernize documentation in place. Enforce no em dashes, readable structure, proper Markdown formatting…
git:20260712.ae7b7ce · audit A · 5 stars
community-health SKILL.md skill
urmzd/dotfiles · dot_agents/skills/community-health/SKILL.md · Scaffold the GitHub Community Standards files (CODE_OF_CONDUCT, SECURITY, ISSUE_TEMPLATE, pull_request_template) using…
git:20260530.d3be4dd · audit A · 5 stars

Every file in urmzd/dotfiles

Other files named write-readme

write-readme SKILL.md skill
huangwb8/skills · skills/alpha/write-readme/SKILL.md · 为 GitHub 项目创建或改写高质量、可执行、证据驱动的双语 README;当用户要求写 README、项目说明或整理项目首页时使用。优先依据项目事实核验功能、命令和链接。
git:20260906.dd1fab8 · audit A · 50 stars
write-readme SKILL.md skill
devantler-tech/agent-plugins · plugins/engineering-practices/skills/write-readme/SKILL.md · Write or improve a newcomer-facing README with a clear product overview, useful existing visuals and badges, and a…
git:20261101.7205f84 · audit A · 3 stars
write-readme SKILL.md skill
devantler-tech/agent-skills · write-readme/SKILL.md · Write or improve a newcomer-facing README with a clear product overview, useful existing visuals and badges, and a…
git:20261025.35a8e1a · audit A · 3 stars

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