readme-craft SKILL.md skillA

readme-craft from mithunwijayasiri/dotclaude is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add mithunwijayasiri/dotclaude/readme-craft@git:20261010.1ebf38d

Pins git:20261010.1ebf38d in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
mithunwijayasiri/dotclaude
Path
skills/readme-craft/SKILL.md
Versions recorded
1
Latest version
git:20261010.1ebf38d, committed Oct 10, 2026
Size
6,248 bytes
Repository stars
4
License
MIT

README writing and restyling — scaffold a new README, restyle an existing one, or add/refresh its badges (shieldcn.dev or shields.io), header, admonitions, collapsibles, and GitHub markdown patterns.

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 craft

Two modes: **new** (scaffold from scratch) and **restyle** (upgrade an existing README's presentation). Same conventions either way.

## Step 1 — ask badge source

Before writing or touching any badge, ask via AskUserQuestion: **shieldcn.dev** or **shields.io**. Never default, never infer from existing badges, never mix sources in one README. Skip only if the user already named the source in this request.

Chosen source can't render a needed badge → tell user and drop it; don't silently fall back to the other source.

Markdown patterns beyond header/badges (admonitions, collapsibles, kbd, mermaid, diff, tables, footnotes, task lists, captions, back-to-top) → `references/markdown-patterns.md`. Read it before writing README body content.

## Header pattern

Centered icon above the title, tagline below:

```html
<p align="center">
  <img src="<path-to-icon>" width="64" height="64" alt="">
</p>

<h1 align="center">Project Name</h1>

<p align="center">
  One-line description.
</p>
```
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add mithunwijayasiri/dotclaude/readme-craft@sha256:799480f755a2c445

The line at the top of this page pins the label git:20261010.1ebf38d, 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_3dvbhvobv6l6qmew.svg)](https://markdownregistry.com/a/art_3dvbhvobv6l6qmew)

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

Versions

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

versioncommittedcommitsizeaudit
git:20261010.1ebf38d latest2026-10-10 1ebf38d 6,248 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 (6248 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

mithunwijayasiri/dotclaude · 4 stars · license MIT · pushed 2026-11-03 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_3dvbhvobv6l6qmew
GET https://markdownregistry.com/api/v1/resolve?ref=mithunwijayasiri/dotclaude/readme-craft
GET https://markdownregistry.com/api/v1/blob/799480f755a2c4455886b56a44b179d6fdb1df69fa86b34b60d2fbaae47d22bc

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 mithunwijayasiri/dotclaude

CLAUDE.md CLAUDE.md file
mithunwijayasiri/dotclaude · CLAUDE.md
git:20261010.1ebf38d · audit A · 4 stars
ask-first SKILL.md skill
mithunwijayasiri/dotclaude · skills/ask-first/SKILL.md · Ask the user clarifying questions before acting, instead of filling gaps with guesses. Use when starting to implement a…
git:20261013.0e269cd · audit A · 4 stars
claude-project-rules SKILL.md skill
mithunwijayasiri/dotclaude · skills/claude-project-rules/SKILL.md · Author Claude Code rule files (.claude/rules/*.md). Use when asked to create, add, edit, or review a project or user…
git:20261026.b29f51d · audit A · 4 stars
compact-markdown SKILL.md skill
mithunwijayasiri/dotclaude · skills/compact-markdown/SKILL.md · Writing style for markdown files. Strips filler, writes telegraphic and content-only — docs are for AI agents, not…
git:20261010.1ebf38d · audit A · 4 stars
humanize SKILL.md skill
mithunwijayasiri/dotclaude · skills/deprecated/humanize/SKILL.md · Remove AI writing patterns from prose. Use when drafting, editing, or reviewing text to eliminate predictable AI tells.
git:20261004.03effb8 · audit A · 4 stars
pr-review SKILL.md skill
mithunwijayasiri/dotclaude · skills/deprecated/pr-review/SKILL.md · Review a PR, branch, commit, or uncommitted changes for correctness bugs, structural regressions, security and…
git:20261004.134b66b · audit A · 4 stars
empty-commit SKILL.md skill
mithunwijayasiri/dotclaude · skills/empty-commit/SKILL.md · Use when a CI pipeline failed on something unrelated to the code and the PR is blocked — pushes an empty commit to…
git:20261011.04bbb86 · audit A · 4 stars
git-merge SKILL.md skill
mithunwijayasiri/dotclaude · skills/git-merge/SKILL.md · Merge one branch (usually the default branch) into the current branch while preserving local unstaged changes…
git:20261011.04bbb86 · audit A · 4 stars
git-worktree SKILL.md skill
mithunwijayasiri/dotclaude · skills/git-worktree/SKILL.md · Use when the user asks to create, enter/switch to, or remove a git worktree on Windows — makes it under…
git:20261009.aa46ea6 · audit B · 4 stars
github-issue-creator SKILL.md skill
mithunwijayasiri/dotclaude · skills/github-issue-creator/SKILL.md · Create or edit GitHub issues from raw notes, error logs, voice dictation or screenshots, following the repo's issue…
git:20261026.436fdc9 · audit A · 4 stars
handoff-session SKILL.md skill
mithunwijayasiri/dotclaude · skills/handoff-session/SKILL.md · Use when the user wants to hand off, continue in a new session, or pass the current work to another agent. Compacts the…
git:20261026.65f3878 · audit A · 4 stars
html-landing-page SKILL.md skill
mithunwijayasiri/dotclaude · skills/html-landing-page/SKILL.md · Static landing pages — single/few-file HTML/CSS/JS for project sites, GitHub Pages, product one-pagers. Build…
git:20261010.1ebf38d · audit A · 4 stars

Every file in mithunwijayasiri/dotclaude

Other files named readme-craft

readme-craft SKILL.md skill
hanzhangzzz/agent-skills-zh · readme-craft/SKILL.md · 为开源项目撰写、重写或审查仓库 README:让读者迅速判断项目是否解决自己的问题,尽快完成第一次真实使用,并逐步理解原理与边界。用于“写 README”“优化开源项目首页”“README 审查”“3 秒抓眼球、30 秒开始、1…
git:20260928.8b03b06 · audit A · 1 stars

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