setup-readme

setup-readme is a skill for Claude Code, Codex from Jerry0022/dotclaude. It costs 90 tokens per session (1,270 once invoked), scanned A, original, MIT.

A tool for generating or substantially updating a project's README.md file. A README is the main documentation page that explains what a project does and how to use it.

In plain words
What is it for?
Use it to create a new README, update an existing one, preserve user-written sections during incremental updates, or preview the planned documentation structure.
Why use it?
It gathers project details from files such as the package manifest, source tree, changelog, and CI configuration so the documentation reflects the codebase.

Skill for Claude CodeCodex

Part of the devops plugin — 23 skills, 12 agents, 5 hooks, 3 MCP servers shipped together

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.

agentmods
npx agentmods add skills/jerry0022/dotclaude/setup-readme
Any agent
npx skills add Jerry0022/dotclaude --skill setup-readme
Clone the repo
git clone --depth 1 https://github.com/Jerry0022/dotclaude

Made for: Claude Code, Codex.

Or install devops, the plugin that ships this one along with the rest of its 23 skills, 12 agents, 5 hooks, 3 MCP servers.

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

README.md
[![agentmods](https://agentmods.dev/badge/skills/jerry0022/dotclaude/setup-readme.svg)](https://agentmods.dev/skills/jerry0022/dotclaude/setup-readme)
Your own site
<a href="https://agentmods.dev/skills/jerry0022/dotclaude/setup-readme"><img src="https://agentmods.dev/badge/skills/jerry0022/dotclaude/setup-readme.svg" alt="Measured on agentmods" height="20"></a>
Per session 90 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,270 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
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 $0.00090 $0.01270
Opus 5 $0.00045 $0.00635
Sonnet 5 $0.00018 $0.00254
Haiku 4.5 $0.00009 $0.00127

Measured 4d ago against content hash c036a8260477, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

setup-readme 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 4d 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.

plugins/devops/skills/setup-readme/SKILL.md · 131 lines

How it starts

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

Setup Readme — README Generator

Generate a modern, informative README.md for the current project.

Step 0 — Load Extensions

Check for optional overrides. Use Glob to verify each path exists before reading. Do NOT call Read on files that may not exist — skip missing files silently (no output).

  1. Global: ~/.claude/skills/setup-readme/SKILL.md + reference.md
  2. Project: {project}/.claude/skills/setup-readme/SKILL.md + reference.md
  3. Merge: project > global > plugin defaults

Arguments

  • --preview: Show planned structure before generating. Auto-enabled for large projects (>20 source files).
  • --update: Incremental update — preserve user-written sections, update version/features/structure.

No flag + no README → full generation. No flag + README exists + small project → full generation.

Step 1 — Analyze the project

Read and analyze:

  1. Manifest file (package.json, Cargo.toml, etc.) → name, version, license, deps
  2. Existing README.md → extract useful content
  3. Source structure via Glob → tech stack, entry points, folder layout
  4. CHANGELOG.md → link to it (do not copy content)
  5. .github/workflows/ → CI presence
  6. docs/, assets/, screenshots/ → available media

Determine:

  • Project name and version
  • One-line description (compelling, specific)
  • Category: developer-facing (library, SDK, CLI) or user-facing (app, tool)
  • Tech stack and key dependencies

Step 2 — Select sections

Based on project category, include relevant sections from this list:

Section Dev-facing User-facing Notes
Hero block (name, tagline, badges) Always Always
Table of Contents If 5+ sections If 5+ sections
Overview / What is this? Why it exists Elevator pitch, no jargon
Screenshots / Demo Optional Preferred
Features Bullet list, emoji prefix User-oriented, emoji prefix
Installation / Getting Started Package manager commands Download/install per platform
Quick Start / Tutorial Minimal code example Step-by-step guide
Usage / API Key API surface How to Use Dev only
Architecture If 3+ modules If multi-process Diagram
Contributing Always Always
License Always Always

Read the full file on GitHub · 131 lines

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. 4d ago First seen · 131 lines · 90 tokens per session scan A c036a8260477

Subscribe to this mod's changes

setup-readme is a skill published in the GitHub repository Jerry0022/dotclaude (5 stars, last pushed today), licensed MIT. It adds 90 tokens to every session and 1,270 once invoked, about $0.0005 per session on Opus 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-08-31.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

brainstorming

You MUST use this before any creative work - creating features, building components, adding functionality, or modifying behavior. Explores user intent, requirements and design before implementation.

obra/superpowers · 37 tokens

auto-perf-optimize

Run agent-driven VS Code performance or memory investigations. Use when asked to launch Code OSS, automate a VS Code scenario, run the Chat memory smoke runner, capture renderer heap snapshots, take workflow screenshots, compare run summaries, or drive a repeatable scenario before heap-snapshot analysis.

microsoft/vscode · 62 tokens

chat-perf

Run chat perf benchmarks and memory leak checks against the local dev build or any published VS Code version. Use when investigating chat rendering regressions, validating perf-sensitive changes to chat UI, or checking for memory leaks in the chat response pipeline.

microsoft/vscode · 51 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens