jig-readme

jig-readme is a skill for Claude Code, Codex from 0x0w1/jig. It costs 130 tokens per session (2,002 once invoked), scanned A, original, MIT.

A guide for creating or updating a project’s README.md, the main document that explains a code project to its users and contributors. It checks the document against the repository before changing it.

In plain words
What is it for?
Use it to classify a project, create missing README documentation, or find and correct outdated claims.
Why use it?
It prevents documentation from becoming inaccurate as commands, files, options, and features change.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one. Also seen: installed under .agents/ (shared by several agents).

Good fit Use it to classify a project, create missing README documentation, or find and correct outdated claims.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/0x0w1/jig/jig-readme
View source ↗ 0x0w1/jig
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 0x0w1/jig --skill jig-readme
Clone the repo
git clone --depth 1 https://github.com/0x0w1/jig

Made for: Claude Code, Codex.

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

README.md
[![agentmods](https://agentmods.dev/badge/skills/0x0w1/jig/jig-readme/github.svg)](https://agentmods.dev/skills/0x0w1/jig/jig-readme)
Your own site
<a href="https://agentmods.dev/skills/0x0w1/jig/jig-readme"><img src="https://agentmods.dev/badge/skills/0x0w1/jig/jig-readme/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.

agentmods 80×15 button for jig-readme

Your own site · 80×15
<a href="https://agentmods.dev/skills/0x0w1/jig/jig-readme"><img src="https://agentmods.dev/badge/skills/0x0w1/jig/jig-readme.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 130 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,002 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.
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.00130 $0.02002
Opus 5 $0.00065 $0.01001
Sonnet 5 $0.00026 $0.00400
Haiku 4.5 $0.00013 $0.00200

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

Security

Grade A, and why

jig-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 6d 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.

Origin

Copies of this mod

1 near-identical copy found in the catalogue:

  • readme — 95% identical, 2 lines differ
.agents/skills/jig-readme/SKILL.md · 138 lines

How it starts

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

README

Use this skill to create or update the repository's README.md from the actual repository state.

Procedure

  1. Scan the repository:
    • Manifest and build files: pyproject.toml, package.json, Cargo.toml, go.mod, Makefile, lock files.
    • Entry points, CLI argument definitions, scripts, and service configs (Dockerfile, docker-compose*.yml).
    • Existing documentation under docs/ and usage examples in the code.
  2. Classify the project type: CLI tool, library, service/app, or other. The type selects the section layout below when no profile is set.
  3. Settle the README profile per the Profile Contract below. A profile that resolves replaces the generic defaults for this repository; when none resolves, propose one and continue either way.
  4. Branch on the current state:
    • No README.mdcreate path: draft the README with the section layout below.
    • README.md exists → update path: check every verifiable claim in the README — commands, options, file paths, links, feature statements — against the repository. Collect mismatches into a drift list, report the list, then apply the fixes. Leave sections that are still accurate untouched.
  5. Apply the accuracy rules to every line written.
  6. Run the compression pass from the Compression Rules below:
    • Create path: apply it while drafting. Nothing was published yet, so there is nothing to propose.
    • Update path: collect the duplication and overstatement into a proposal — name each fact, where it is repeated, and which detail doc would hold it — then ask before moving anything. Report the proposal even when the user declines it.
  7. Merge the change:
    • When the repository has the develop-task-flow skill (or the installed jig-develop-task-flow), follow it: a chore/<slug> branch, a squash merge with a docs: commit, then push develop.
    • Otherwise propose a normal commit on the current branch.

Profile Contract

Two repositories that are the same project type still write their READMEs differently: one keeps a translated mirror, another moves installation into a guide, a third has a table convention its contributors already follow. Those are decisions, not facts the repository can be scanned for, so they are recorded once and read on every later run.

Read the full file on GitHub · 138 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. 6d ago Changed · +72 lines · +41 tokens per session 9d4fd365a051
  2. 9d ago First seen · 66 lines · 89 tokens per session scan A 870fd170f794

Subscribe to this mod's changes

jig-readme is a skill published in the GitHub repository 0x0w1/jig (5 stars, last pushed 6d ago), licensed MIT. It adds 130 tokens to every session and 2,002 once invoked, about $0.0006 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.