readme

A command for creating a README.md file, the main guide that explains a software repository. It analyzes the project before writing the document.

In plain words
What is it for?
It is for drafting documentation about a project, including its purpose, structure, usage, and other information found in the codebase.
Why use it?
It gives a repository a starting point for explaining what it contains and how people should use it. It can draw information from project files, dependencies, and Git history.

Command for Claude Code

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 commands/arome3/code-to-content/readme
Clone the repo
git clone --depth 1 https://github.com/arome3/code-to-content

Made for: Claude Code.

Per session 7 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 588 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.00007 $0.00588
Opus 5 $0.00003 $0.00294
Sonnet 5 $0.00001 $0.00118
Haiku 4.5 $0.00001 $0.00059

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

Security

Grade A, and why

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 2d 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.

.claude/commands/c2c/readme.md · 69 lines

How it starts

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

Generate Repository README

Create a comprehensive README.md for the provided project.

Differentiation Discovery (offer; never blocking): Before generating, offer to make this unmistakably theirs — ask for the WHY (the thesis/stakes), one defensible opinion, a road not taken, or a rough draft to polish ("write it ugly; I'll keep your voice"). Rank raw material (Slack threads, support tickets, a voice-memo transcript) above clean specs. If declined, proceed on code alone and flag Distinctiveness: AT RISK. At delivery, run the swap-the-name test + AI-tells blocklist from references/differentiation.md.

Process

  1. Analyze the Project Analyze the codebase Claude-natively (read dependency files, detect architecture, grep story hooks like TODO/FIXME, mine git log) — see references/analysis-prompts.md. No scripts required.

  2. Load Skill Context Read these files:

    • skills/code-to-content/SKILL.md
    • skills/code-to-content/references/differentiation.md (WHY / opinion / roads-not-taken)
    • skills/code-to-content/assets/templates/readme.md
    • skills/code-to-content/references/documentation.md
  3. Extract Key Information From analysis, identify:

    • One-line description (what + key benefit)
    • Problem being solved (pain point)
    • Target users
    • Key features (3-5)
    • Tech stack and dependencies
    • Configuration options
  4. Generate README Sections Follow priority order:

    Level 1 - Identity (always):

    • Title with badges
    • One-line description
    • The Problem / The Solution

    Level 2 - Usage (always):

    • Quick Start (working in <5 minutes)
    • Basic usage examples

    Level 3 - Details (if non-trivial):

    • Configuration table (all options)
    • Architecture overview/diagram
    • API reference (if applicable)

    Level 4 - Contribution (if open source):

    • Development setup
    • Testing commands
    • Contributing link

    Level 5 - Reference:

    • Troubleshooting FAQ
    • Changelog link
    • License

Read the full file on GitHub · 69 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. 2d ago First seen · 69 lines · 7 tokens per session scan A df3c5349e30f

Subscribe to this mod's changes

readme is a command published in the GitHub repository arome3/code-to-content (6 stars, last pushed 2mo ago), licensed MIT. It adds 7 tokens to every session and 588 once invoked, about $0.0000 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.