What is readme-generator?

A README writing and refactoring workflow based on evidence found in a repository. A README is the project’s main guide for users and maintainers.

Use it to create or standardize README files for services, libraries, command-line tools, or monorepos—repositories containing multiple related projects.

It reduces inaccurate documentation by requiring statements, commands, paths, and project details to match the actual repository.

readme-generator — Skill for Claude Code by johnqtcg

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 johnqtcg/awesome-skills --skill readme-generator

Clone the repo

git clone --depth 1 https://github.com/johnqtcg/awesome-skills

Made for: Claude Code.

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.

README.md

[![agentmods](https://agentmods.dev/badge/skills/johnqtcg/awesome-skills/readme-generator/github.svg)](https://agentmods.dev/skills/johnqtcg/awesome-skills/readme-generator)

Your own site

<a href="https://agentmods.dev/skills/johnqtcg/awesome-skills/readme-generator"><img src="https://agentmods.dev/badge/skills/johnqtcg/awesome-skills/readme-generator/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.

Your own site · 80×15

<a href="https://agentmods.dev/skills/johnqtcg/awesome-skills/readme-generator"><img src="https://agentmods.dev/badge/skills/johnqtcg/awesome-skills/readme-generator.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 54 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.

When invoked 5,142 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. Third-party audits

NVIDIA SkillSpector warn 7 Sept 2026

SkillSpector: 1 finding, up to medium

These are SkillSpector’s own severities. On a checked sample its high-severity flags on skills were ~96% false positives — a documented command, a public API, a “never do X” rule — so we show them as a caution to read, not a verdict. Why →

medium Excessive Agency · line 346
Skill enables autonomous high-impact decisions without human-in-the-loop verification. Critical operations (destructive commands, financial transactions, data deletion) should require explicit user confirmation.

Fix: Add human-in-the-loop confirmation for destructive, irreversible, or high-impact operations. Never auto-execute commands that modify files, send data, or alter system state.

How audits are shown

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.

Model	Per session	Once invoked
Fable 5.1	$0.00054	$0.05142
Opus 5	$0.00027	$0.02571
Sonnet 5	$0.00011	$0.01028
Haiku 4.5	$0.00005	$0.00514

Measured 11d ago against content hash 8545d5408bd3, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-11, from the pricing page.

Security

Grade A, and why

readme-generator 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 11d ago.

The scan reads SKILL.md. This mod also ships 8 executable files (scripts/discover_readme_needs.sh, scripts/lint_readme.py, scripts/run_live_eval.sh, …), listed below but not scanned — reading those needs a real analyzer, not pattern matching.

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-generator/SKILL.md · 387 lines

How it starts

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

README Generator

Generate high-quality README documents from codebase evidence, with clear structure, runnable commands, and maintenance rules.

Core Rules

Base every statement on repository evidence (files, code, scripts, workflows, configs).
Keep internal workflow reporting out of the README body. Evidence maps, scorecards, and verification state belong in the assistant response — see §Command Verifiability Gate.
Exclude local/private tooling folders by default (for example .codex/) unless asked.
Keep naming and paths consistent with the real repository layout.
Treat top-level README.md as a user-facing homepage first, a maintainer reference second.

Evidence Precedence (resolves "omit or mark?")

One rule, applied by section class — there is no third case:

Section class	Evidence present	Evidence missing
Required for the project type (§Structure Policy)	Write it	Keep the heading, write `Not found in repo`
Optional (§Optional Sections)	Write it	Omit entirely and list it in `sections_omitted`

Facts vs Results (resolves "is this command fabricated?")

A manifest proves a toolchain; only an artifact proves a result.

Evidence-backed: go test ./... when go.mod exists, pytest when pyproject.toml exists, make <target> when that exact target is in the Makefile.
Not evidence-backed: coverage percentages, test counts, benchmark numbers, throughput, latency, or a response body — unless the repo commits the artifact they come from (a checked-in benchstat output, a golden fixture, a committed coverage report).
A config file proves a target, never a measurement. .codecov.yml with target: 80% licenses "the coverage target is 80%", not "coverage is 80%" — the latter asserts a result the repo does not record. The linter enforces that split.
If a repo has a manifest but no test files, still show the toolchain command and add No test files found in repo — the command is real, the coverage claim would not be.

Read the full file on GitHub · 387 lines

Files

What ships with it

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

11d ago First seen · 387 lines · 54 tokens per session scan A 8545d5408bd3

Subscribe to this mod's changes

readme-generator is a skill published in the GitHub repository johnqtcg/awesome-skills (30 stars, last pushed today), licensed MIT. It adds 54 tokens to every session and 5,142 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.

Claude Code Writing and docs agents ai-assistant ai-skills anthropic developer-tools

security-compliance

Guides security professionals in implementing defense-in-depth security architectures, achieving compliance with industry frameworks (SOC2, ISO27001, GDPR, HIPAA), conducting threat modeling and risk assessments, managing security operations and incident response, and embedding security throughout the SDLC.

sangrokjung/claude-forge · 56 tokens

stride-analysis-patterns

Apply STRIDE methodology to systematically identify threats. Use when analyzing system security, conducting threat modeling sessions, or creating security documentation.

sangrokjung/claude-forge · 30 tokens

cache-components

Expert guidance for Next.js Cache Components and Partial Prerendering (PPR). PROACTIVE ACTIVATION: Use this skill automatically when working in Next.js projects that have cacheComponents: true in their next.config.ts/next.config.js. When this config is detected, proactively apply Cache Components patterns and best…

sangrokjung/claude-forge · 183 tokens

manage-skills

A maintenance workflow for checking whether project verification skills still cover the code and rules that changed during a session.

sangrokjung/claude-forge · 54 tokens

blind-spot-pass

Use before starting work in a domain you don't know well, to surface the "unknown unknowns" — the things you don't even know to ask about — and learn just enough to prompt and decide well. Implements the "blind spot pass" pattern from Anthropic's Fable "finding your unknowns" field guide. Triggers when you say "I'm…

sangrokjung/claude-forge · 221 tokens

skill-factory

A workflow that examines completed session work and turns reusable patterns into Claude Code skills.

sangrokjung/claude-forge · 122 tokens