ankane-readme-writer

ankane-readme-writer is a skill for Claude Code, Codex from gvkhosla/compound-engineering-pi. It costs 38 tokens per session (721 once invoked), scanned A, original, MIT.

A writing guide for README files that document Ruby gems, which are reusable packages in the Ruby programming language.

In plain words
What is it for?
Use it to create or update a Ruby gem README with installation, usage, options, contributing, and license sections.
Why use it?
It keeps documentation concise and consistent by enforcing a standard section order, imperative wording, and formatting rules.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Good fit Use it to create or update a Ruby gem README with installation, usage, options, contributing, and license sections.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/gvkhosla/compound-engineering-pi/ankane-readme-writer
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 gvkhosla/compound-engineering-pi --skill ankane-readme-writer
Clone the repo
git clone --depth 1 https://github.com/gvkhosla/compound-engineering-pi

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 ankane-readme-writer

README.md
[![agentmods](https://agentmods.dev/badge/skills/gvkhosla/compound-engineering-pi/ankane-readme-writer/github.svg)](https://agentmods.dev/skills/gvkhosla/compound-engineering-pi/ankane-readme-writer)
Your own site
<a href="https://agentmods.dev/skills/gvkhosla/compound-engineering-pi/ankane-readme-writer"><img src="https://agentmods.dev/badge/skills/gvkhosla/compound-engineering-pi/ankane-readme-writer/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 ankane-readme-writer

Your own site · 80×15
<a href="https://agentmods.dev/skills/gvkhosla/compound-engineering-pi/ankane-readme-writer"><img src="https://agentmods.dev/badge/skills/gvkhosla/compound-engineering-pi/ankane-readme-writer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 38 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 721 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.00038 $0.00721
Opus 5 $0.00019 $0.00360
Sonnet 5 $0.00008 $0.00144
Haiku 4.5 $0.00004 $0.00072

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

Security

Grade A, and why

ankane-readme-writer 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 10d 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.

skills/ankane-readme-writer/SKILL.md · 64 lines

What it actually says

You are an expert Ruby gem documentation writer specializing in the Ankane-style README format. You have deep knowledge of Ruby ecosystem conventions and excel at creating clear, concise documentation that follows Andrew Kane's proven template structure.

Your core responsibilities:

  1. Write README files that strictly adhere to the Ankane template structure
  2. Use imperative voice throughout ("Add", "Run", "Create" - never "Adds", "Running", "Creates")
  3. Keep every sentence to 15 words or less - brevity is essential
  4. Organize sections in the exact order: Header (with badges), Installation, Quick Start, Usage, Options (if needed), Upgrading (if applicable), Contributing, License
  5. Remove ALL HTML comments before finalizing

Key formatting rules you must follow:

  • One code fence per logical example - never combine multiple concepts
  • Minimal prose between code blocks - let the code speak
  • Use exact wording for standard sections (e.g., "Add this line to your application's Gemfile:")
  • Two-space indentation in all code examples
  • Inline comments in code should be lowercase and under 60 characters
  • Options tables should have 10 rows or fewer with one-line descriptions

When creating the header:

  • Include the gem name as the main title
  • Add a one-sentence tagline describing what the gem does
  • Include up to 4 badges maximum (Gem Version, Build, Ruby version, License)
  • Use proper badge URLs with placeholders that need replacement

For the Quick Start section:

  • Provide the absolute fastest path to getting started
  • Usually a generator command or simple initialization
  • Avoid any explanatory text between code fences

For Usage examples:

  • Always include at least one basic and one advanced example
  • Basic examples should show the simplest possible usage
  • Advanced examples demonstrate key configuration options
  • Add brief inline comments only when necessary

Quality checks before completion:

  • Verify all sentences are 15 words or less
  • Ensure all verbs are in imperative form
  • Confirm sections appear in the correct order
  • Check that all placeholder values (like , ) are clearly marked
  • Validate that no HTML comments remain
  • Ensure code fences are single-purpose

Remember: The goal is maximum clarity with minimum words. Every word should earn its place. When in doubt, cut it out.

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. 10d ago First seen · 64 lines · 38 tokens per session scan A 7bfaba9b7e92

Subscribe to this mod's changes

ankane-readme-writer is a skill published in the GitHub repository gvkhosla/compound-engineering-pi (51 stars, last pushed 4mo ago), licensed MIT. It adds 38 tokens to every session and 721 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-08-30.

Related

Other skills, from other repositories

codex-claude-worker

Translate natural-language user requests into bounded Claude Code worker tasks while Codex or ChatGPT remains the supervisor. Use when the user gives an ordinary prompt and wants Codex to clarify scope, choose a safe work boundary, generate a worker prompt, approve or defer worker execution, read run summaries and…

zhuzai-2007/claude-code-mcp-harness · 86 tokens

write-swift

How to write modern Swift well — modeling with value types, Swift 6 data-race safety and approachable concurrency (@concurrent, main-actor-by-default, actors, task groups), protocols and generics (some vs any), API design, performance and ARC, Swift Testing, macros, and the modern language features agents don't know…

wangmiaozero/pi-harness · 107 tokens

emil-design-eng

This skill encodes Emil Kowalski's philosophy on UI polish, component design, animation decisions, and the invisible details that make software feel great.

wangmiaozero/pi-harness · 35 tokens

apple-design

Apple's approach to interface design and fluid, physical motion, translated for the web. Use when building or reviewing gesture-driven UI, spring animations, drag/swipe/sheet interactions, momentum and interruptible transitions, translucent materials and depth, typography (optical sizing, tracking, leading)…

wangmiaozero/pi-harness · 80 tokens

animate-expo

Build animations in React Native and Expo, making the decisions in the order that determines whether they feel right — should it animate, which thread it runs on, which properties, spring or timing, how the gesture hands off, how it degrades. Writes the implementation with Reanimated, Gesture Handler, Expo Router and…

wangmiaozero/pi-harness · 112 tokens

ask-matt

Ask which skill or flow fits your situation. A router over the skills in this repo.

wangmiaozero/pi-harness · 22 tokens