readme-craft

readme-craft is a skill for Claude Code, Codex from MithunWijayasiri/dotclaude. It costs 51 tokens per session (1,521 once invoked), scanned A, original, MIT.

A README writing and restyling skill for GitHub projects. A README is the main Markdown introduction to a code repository; this skill can scaffold one, revise its presentation, or update its badges and common Markdown sections.

In plain words
What is it for?
Use it to create or refresh a README with a header, badges, notices, collapsible sections, tables, diagrams, task lists, and other GitHub Markdown elements.
Why use it?
It gives README work a defined structure instead of leaving headings, badges, and formatting choices inconsistent. It also requires the badge source to be chosen before badges are changed.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one. Also seen: names the AskUserQuestion tool.

Good fit Use it to create or refresh a README with a header, badges, notices, collapsible sections, tables, diagrams, task lists, and other GitHub Markdown elements.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/mithunwijayasiri/dotclaude/readme-craft
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add MithunWijayasiri/dotclaude --skill readme-craft
Clone the repo
git clone --depth 1 https://github.com/MithunWijayasiri/dotclaude

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for readme-craft

README.md
[![agentmods](https://agentmods.dev/badge/skills/mithunwijayasiri/dotclaude/readme-craft/github.svg)](https://agentmods.dev/skills/mithunwijayasiri/dotclaude/readme-craft)
Your own site
<a href="https://agentmods.dev/skills/mithunwijayasiri/dotclaude/readme-craft"><img src="https://agentmods.dev/badge/skills/mithunwijayasiri/dotclaude/readme-craft/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for readme-craft

Your own site · 80×15
<a href="https://agentmods.dev/skills/mithunwijayasiri/dotclaude/readme-craft"><img src="https://agentmods.dev/badge/skills/mithunwijayasiri/dotclaude/readme-craft.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 51 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,521 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00051 $0.01521
Opus 5.5 $0.00020 $0.00608
Sonnet 5.5 $0.00010 $0.00304
Haiku 4.5 $0.00005 $0.00152

Measured 10d ago against content hash 799480f755a2, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

readme-craft scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 10d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/readme-craft/SKILL.md · 118 lines

How it starts

The opening of the file, as written. The whole thing — 118 lines — stays where its author put it; the contents beside it link to each section on GitHub.

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:

<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>

Icon: prefer an existing favicon/app-icon asset (PNG/ICO). GitHub strips inline <svg> from rendered READMEs, so even if a .svg logo exists, reference it via <img> (rendered as a raster preview by GitHub) or use a PNG/ICO sibling if one exists. Look in docs/assets/, public/, assets/, or repo root; ask the user for a path if nothing obvious is found — don't guess a project's icon. Separate dark/light icon assets → themed logo pattern in references/markdown-patterns.md.

Badges

Every badge: live or meaningful signal + <a href> to the page it represents (stargazers, npm page, workflow runs, LICENSE, funding page). No bare decorative badges.

shieldcn.dev

Base https://shieldcn.dev. Wrap every badge in <picture> with dark <source> + light <img> fallback:

<a href="<link-target>"><picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/<path>.svg?mode=dark"><img alt="<Label>" src="https://shieldcn.dev/<path>.svg?mode=light"></picture></a>

Read the full file on GitHub · 118 lines

Files

What ships with it

1 file beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 10d ago First seen · 118 lines · 51 tokens per session scan A 799480f755a2

Subscribe to this mod's changes

readme-craft is a skill published in the GitHub repository MithunWijayasiri/dotclaude (4 stars, last pushed 6d ago), licensed MIT. It adds 51 tokens to every session and 1,521 once invoked, about $0.0002 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-10-11.

Related

Other skills, from other repositories

preserve-security-evidence

Preserve security evidence before analysis, containment, or remediation changes it. Use for artifacts, volatile host state, vulnerability validation, records, logs, screenshots, commands, hashes, timelines, and reproducible handoffs.

gaelic-ghost/socket · 49 tokens

memorb-ingest

A skill for turning raw content into structured memory pages. It is intended for material such as transcripts, articles, and PDFs.

iamjosuho/memOrb · 79 tokens

recording-transcription

Turns a manually supplied meeting or one-on-one recording (phone recording, m4a/mp3/wav — anything that is not a Teams meeting) into a reliable transcript. Probes whether local Whisper is usable, normalises and chunks long audio, transcribes in the background with progress polling, converts Simplified to Traditional…

iamjosuho/memOrb · 203 tokens

pydicom

Reads, inspects, writes, transforms, and preflights local DICOM datasets and pixel data. Applies to DICOM metadata, transfer syntaxes, compression plugins, frames, private elements, JSON, and bounded de-identification review.

K-Dense-AI/scientific-agent-skills · 52 tokens

venue-templates

Prepares journal manuscripts, conference papers, research posters, and grant documents using venue-specific formatting guidance and bundled LaTeX scaffolds. Supports selecting an official template, checking current page or anonymity rules, adapting academic writing to a venue, or inspecting a submission PDF.

K-Dense-AI/scientific-agent-skills · 57 tokens

baoyu-youtube-transcript

A tool for downloading the written captions, subtitles, chapter information, speaker labels, and cover image from a YouTube video using its URL or ID.

JimLiu/baoyu-skills · 107 tokens