readme-creator

readme-creator is a skill for Claude Code, Codex from mblode/agent-skills. It costs 68 tokens per session (3,103 once invoked), scanned A, original, MIT.

A workflow for writing or replacing a project's README, the main introduction people see before deciding whether to use it. It adapts the sections to the kind of project, such as a CLI, library, app, framework, monorepo, or skill bundle.

In plain words
What is it for?
Use it to create a public-facing README for a project and choose relevant capability sections based on the project's type.
Why use it?
It focuses the README on potential users rather than contributor-only details. The result gives readers a quick installation path and a runnable example.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one. Also seen: mentions CLAUDE.md; mentions AGENTS.md.

Part of the agent-skills plugin — 27 skills 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/mblode/agent-skills/readme-creator
Any agent
npx skills add mblode/agent-skills --skill readme-creator
Clone the repo
git clone --depth 1 https://github.com/mblode/agent-skills

Made for: Claude Code, Codex.

Or install agent-skills, the plugin that ships this one along with the rest of its 27 skills.

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

README.md
[![agentmods](https://agentmods.dev/badge/skills/mblode/agent-skills/readme-creator.svg)](https://agentmods.dev/skills/mblode/agent-skills/readme-creator)
Your own site
<a href="https://agentmods.dev/skills/mblode/agent-skills/readme-creator"><img src="https://agentmods.dev/badge/skills/mblode/agent-skills/readme-creator.svg" alt="Measured on agentmods" height="20"></a>
Per session 68 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 3,103 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.1 $0.00068 $0.03103
Opus 5 $0.00034 $0.01551
Sonnet 5 $0.00014 $0.00621
Haiku 4.5 $0.00007 $0.00310

Measured yesterday against content hash 00392ef36fb7, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

readme-creator 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 yesterday.

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-creator/SKILL.md · 154 lines

How it starts

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

README Creator

Write a README that reads as a shop window, not a wiki.

  • IS: writing or rewriting README.md for the person deciding whether to use the project, with the project type driving which capability sections earn a place and where the file will render (GitHub only, or also a registry page) driving image and badge choices.
  • IS NOT: polishing the prose of a README that already covers the project, or a multi-page docs site (use docs-writing); AGENTS.md or CLAUDE.md agent-instruction files (use agents-md); fixing the install or first-run experience the README describes (use dx-audit); marketing copy for a landing page (use copywriting).

The reader

Someone arrived from a search result, a registry listing, or a profile page. They have about fifteen seconds and one question: is this worth my time? Every line either answers that or gets cut.

They are not a contributor. Nothing about the build pipeline, the workspace layout, the release process, or the coding standards helps them decide, so none of it belongs here.

This deliberately departs from standard-readme and Make a README, which require ## Contributing, add a table of contents past 100 lines, and hold that too long beats too short. Do not drift back to those defaults: contributor content moves to CONTRIBUTING.md or AGENTS.md, and length follows what the reader needs.

Reference Files

File Read when
references/section-templates.md Phase 3: markup for each spine section, the capability-section menu, and per-type notes
references/badges-and-shields.md Phase 4: only once Phase 1 has found a registry listing (npm, crates.io, PyPI, VS Code Marketplace, skills.sh)
references/quality-checklist.md Phase 5: score before declaring done

Voice

Check for a profile from the external ghostwriter skill before drafting: ${GHOSTWRITER_HOME:-~/.config/ghostwriter}/readme.md. When one exists it owns the register, the spelling convention, and any house-style markup (header block, badge colours, footer credit), and it wins every conflict with this skill. Follow it; do not restate it here.

Read the full file on GitHub · 154 lines

Files

What ships with it

4 files 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. yesterday Changed · +10 lines · -100 tokens per session 00392ef36fb7
  2. 6d ago First seen · 144 lines · 168 tokens per session scan A c5f86868a601

Subscribe to this mod's changes

readme-creator is a skill published in the GitHub repository mblode/agent-skills (103 stars, last pushed yesterday), licensed MIT. It adds 68 tokens to every session and 3,103 once invoked, about $0.0003 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-30.