configure-readme

configure-readme is a skill for Claude Code from laurigates/claude-plugins. It costs 33 tokens per session (2,025 once invoked), scanned A, original, MIT.

A setup and audit guide for README.md files, the main project introduction shown in a repository. It covers logos, badges, features, technology details, installation, and project structure.

In plain words
What is it for?
Use it to create or review a README, add badges and technology sections, document install and test commands, and standardize README structure across projects.
Why use it?
It helps readers understand what a project is, how it is built, and how to run it without searching through the repository.

Skill for Claude Code

Written for Claude Code: allowed-tools in frontmatter. Also seen: names the AskUserQuestion tool.

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

Made for: Claude Code.

Or install configure-plugin, the plugin that ships this one along with the rest of its 48 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 configure-readme

README.md
[![agentmods](https://agentmods.dev/badge/skills/laurigates/claude-plugins/configure-readme.svg)](https://agentmods.dev/skills/laurigates/claude-plugins/configure-readme)
Your own site
<a href="https://agentmods.dev/skills/laurigates/claude-plugins/configure-readme"><img src="https://agentmods.dev/badge/skills/laurigates/claude-plugins/configure-readme.svg" alt="Measured on agentmods" height="20"></a>
Per session 33 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,025 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.00033 $0.02025
Opus 5 $0.00016 $0.01012
Sonnet 5 $0.00007 $0.00405
Haiku 4.5 $0.00003 $0.00202

Measured 2d ago against content hash 5e853ddfd6d5, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

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

configure-plugin/skills/configure-readme/SKILL.md · 195 lines

How it starts

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

When to Use This Skill

Use this skill when... Use another approach when...
Creating a README.md for a new project from scratch Editing specific README content — use direct file editing
Auditing an existing README for missing sections (badges, install, structure) Writing detailed API documentation — use /configure:docs
Standardizing README format across multiple projects Creating GitHub Pages documentation site — use /configure:github-pages
Adding shields.io badges, tech stack table, or project structure section Writing a changelog — use release-please automation via conventional commits
Ensuring README includes correct install/build/test commands for the detected stack Only need to update a single section — edit the file directly

Context

  • Project root: !pwd
  • Project name: !basename $(pwd)
  • README exists: !find . -maxdepth 1 -name 'README.md'
  • Package files: !find . -maxdepth 1 \( -name 'package.json' -o -name 'pyproject.toml' -o -name 'Cargo.toml' -o -name 'go.mod' \)
  • Git remotes: !git remote -v
  • License file: !find . -maxdepth 1 -name 'LICENSE*'
  • Assets directory: !find . -maxdepth 2 -type d \( -name 'assets' -o -name 'public' -o -name 'images' \)
  • Logo files: !find . -maxdepth 3 -type f \( -name 'logo*' -o -name 'icon*' \)

Parameters

Parse from command arguments:

  • --check-only: Report README compliance status without modifications (CI/CD mode)
  • --fix: Apply fixes automatically without prompting
  • --style <minimal|standard|detailed>: README detail level (default: standard)
  • --badges <shields|custom>: Badge style preference (default: shields)
  • --no-logo: Skip logo section even if assets exist

Style Levels:

  • minimal: Title, description, badges, basic install/usage
  • standard: Logo, badges, features, tech stack, getting started, license (recommended)
  • detailed: All of standard plus: architecture diagram, API reference, contributing guide, changelog link

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

Subscribe to this mod's changes

configure-readme is a skill published in the GitHub repository laurigates/claude-plugins (58 stars, last pushed yesterday), licensed MIT. It adds 33 tokens to every session and 2,025 once invoked, about $0.0002 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-09-03.