readme

readme is a skill for Claude Code from sorah/config. It costs 103 tokens per session (2,988 once invoked), scanned A, original, MIT.

README-writing guidance for open-source libraries, command-line tools, services, gems, and crates. A README is the main document that explains a project and how to start using it.

In plain words
What is it for?
Use it to create or improve README files, gather installation and usage details, and prepare a project for public release.
Why use it?
It focuses the document on verified project facts and on helping a newcomer decide quickly whether the software fits.

Skill for Claude Code

Written for Claude Code: shipped in a Claude Code plugin.

Part of the sorah-guides plugin — 15 skills, 3 commands, 1 agent shipped together

Good fit Use it to create or improve README files, gather installation and usage details, and prepare a project for public release.

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

Made for: Claude Code.

Or install sorah-guides, the plugin that ships this one along with the rest of its 15 skills, 3 commands, 1 agent.

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 readme

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/sorah/config/readme"><img src="https://agentmods.dev/badge/skills/sorah/config/readme.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 103 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,988 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.00103 $0.02988
Opus 5.5 $0.00041 $0.01195
Sonnet 5.5 $0.00021 $0.00598
Haiku 4.5 $0.00010 $0.00299

Measured yesterday against content hash f0ade18ba1e3, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, 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 yesterday.

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/marketplace/plugins/sorah-guides/skills/readme/SKILL.md · 188 lines

How it starts

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

README

Conventions for composing READMEs for open source libraries, CLI tools, and services. Derived from sorah's own projects and from the top-downloaded crates.io and rubygems.org projects. Project-specific conventions and an existing README's established style always take priority.

A README has one job: let a stranger decide within one screen whether the project solves their problem, then get them to a working first use. Everything else is optional and must earn its place.

Workflow

  1. Gather facts from the repository before writing. Never invent them.
    • Name, package name, and registry (*.gemspec, Cargo.toml, package.json, go.mod)
    • Actual install channels: published gem/crate, Homebrew tap, AUR, container image, GitHub release binaries (check CI release workflows)
    • Minimum language/runtime version (required_ruby_version, rust-version, engines)
    • CLI help output (--help) and real config samples in the repo (config.sample.yml, contrib/, examples/)
    • LICENSE* files and copyright holder; SECURITY.md, CONTRIBUTING.md, docs/
    • Upstream projects it wraps, replaces, or was inspired by
  2. Classify the project (see Project Shapes) to pick a skeleton and length.
  3. Write the opening (title, tagline, first paragraph) first. If it cannot be written in two sentences, the project's positioning is unclear. Ask the user rather than pad.
  4. Write the smallest working example, then fill remaining sections.
  5. Verify every command, path, flag, and link against the repository. Run the example when feasible.
  6. Review against the Checklist.

When improving an existing README, preserve its voice, heading style, and structure unless asked for a rewrite. Fix inaccuracies and stale content first, then add missing essentials.

Project Shapes

Shape Examples Length Notes
Foundational library libc, itoa, cfg-if Very short Purpose sentence, dependency snippet, one example, docs link, MSRV, license
Focused library thiserror, anyhow, webmock, hocho Short–medium Example-driven; README may be the manual
Framework / large library tokio, sidekiq, faraday Medium, docs elsewhere README is a hub: pitch, minimal example, links to guides/API docs
CLI tool ripgrep, fd, mairu, envchain Medium–long Install matrix, quick usage, config, comparisons
Service / daemon himari, ecamo, needroleshere Medium–long How it works, setup, configuration, security model, caveats

Read the full file on GitHub · 188 lines

Files

What ships with it

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

  1. yesterday First seen · 188 lines · 103 tokens per session scan A f0ade18ba1e3

Subscribe to this mod's changes

readme is a skill published in the GitHub repository sorah/config (31 stars, last pushed yesterday), licensed MIT. It adds 103 tokens to every session and 2,988 once invoked, about $0.0004 per session on Opus 5.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-10-17.

Related

Other skills, from other repositories

local-ai-agents

Build local-first AI agents that run entirely on a developer workstation with Microsoft Foundry Local and Qwen function-calling models. Covers Small Language Models (SLMs), the OpenAI-compatible local endpoint, sandboxed local tools, local RAG with Chroma, local MCP servers, hybrid cloud/local routing, and the…

microsoft/ai-agents-for-beginners · 200 tokens

next-cache-components-adoption

Turn on Cache Components in a Next.js app and resolve the blocking routes it surfaces. Use when the user wants to enable, adopt, or migrate to Cache Components, flip the cacheComponents flag, work through a flood of blocking-prerender / instant validation errors, run the cache-components-instant-false codemod, or…

vercel/next.js · 95 tokens

chronicle

Analyze Copilot session history for standup reports, usage tips, session search, and session reindexing. Use when the user asks for a standup, daily summary, usage tips, workflow recommendations, wants to search or find past sessions by keyword/file/PR, wants to reindex their session store, or asks about deleting…

microsoft/vscode · 72 tokens

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

component-fixtures

Use when creating or updating component fixtures for screenshot testing or their shared infrastructure, or when designing UI components to be fixture-friendly. Covers fixture file structure, theming, service setup, CSS scoping, async rendering, validation, and common pitfalls.

microsoft/vscode · 53 tokens