What is readme-writer?

A writing workflow for creating or improving a software project's README.md file. A README is the document that explains what a project is, how to install it, and how to use it.

Inspecting project files, gathering missing information, and drafting structured README sections such as the overview, installation, first example, and deeper documentation.

It helps turn incomplete or confusing project documentation into a clear path from first impression to first successful use.

readme-writer — Skill for Claude Code by psenger

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 psenger/ai-agent-skills --skill readme-writer

Clone the repo

git clone --depth 1 https://github.com/psenger/ai-agent-skills

Made for: Claude Code.

Or install psenger-skills, the plugin that ships this one along with the rest of its 14 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.

README.md

[![agentmods](https://agentmods.dev/badge/skills/psenger/ai-agent-skills/readme-writer/github.svg)](https://agentmods.dev/skills/psenger/ai-agent-skills/readme-writer)

Your own site

<a href="https://agentmods.dev/skills/psenger/ai-agent-skills/readme-writer"><img src="https://agentmods.dev/badge/skills/psenger/ai-agent-skills/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.

Your own site · 80×15

<a href="https://agentmods.dev/skills/psenger/ai-agent-skills/readme-writer"><img src="https://agentmods.dev/badge/skills/psenger/ai-agent-skills/readme-writer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

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

When invoked 2,788 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.

Model	Per session	Once invoked
Fable 5.1	$0.00148	$0.02788
Opus 5	$0.00074	$0.01394
Sonnet 5	$0.00030	$0.00558
Haiku 4.5	$0.00015	$0.00279

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

Security

Grade A, and why

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 11d 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/readme-writer/SKILL.md · 177 lines

How it starts

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

README Writer

Produce README.md files that help a reader decide, in under thirty seconds, whether the project is worth their time — and then help them use it successfully.

A good README is a conversion funnel: headline → understand → install → first success → deeper docs. Every section either moves the reader along that funnel or earns its keep in some other way (badges signal trust, license reassures lawyers). Sections that don't serve the reader get cut.

Workflow

Follow these steps in order. Don't skip the intake — a README written without knowing the project is a Mad Libs page of plausible nonsense.

1. Intake — learn the project before writing anything

Gather three kinds of information: what can be auto-detected, what must be asked, and what lives in the code.

Auto-detect by inspecting the repo. If you have filesystem access, look for:

package.json — Node project. Read name, description, version, scripts, dependencies, bin, main/exports, engines, repository, license, keywords.
pyproject.toml / setup.py / setup.cfg — Python project. Read project name, deps, entry points, Python version constraints.
Cargo.toml — Rust crate. Read [package] metadata.
go.mod — Go module. Read module path and Go version.
Gemfile / *.gemspec — Ruby.
composer.json — PHP.
pubspec.yaml — Dart/Flutter.
Dockerfile, docker-compose.yml — containerized service.
.github/workflows/* — CI signals (test, build, deploy).
LICENSE / LICENCE — license file.
CHANGELOG.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md — existing docs to link to rather than duplicate.
src/, lib/, cmd/, app/ layout — informs project shape.
An existing README.md — always read it first. If it exists, you're rewriting, not replacing; preserve anything still accurate (correct install commands, working examples, the project's actual voice).

Classify the project. The shape of the README depends on what kind of thing this is:

Read the full file on GitHub · 177 lines

Files

What ships with it

17 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 · 177 lines · 148 tokens per session scan A 3e7f841cdb31

Subscribe to this mod's changes

readme-writer is a skill published in the GitHub repository psenger/ai-agent-skills (10 stars, last pushed 3mo ago), licensed MIT. It adds 148 tokens to every session and 2,788 once invoked, about $0.0007 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.

Claude Code Writing and docs agent-skills ai-agent claude codex developer-tools

article-writing

Write articles, guides, blog posts, tutorials, newsletter issues, and other long-form content in a distinctive voice derived from supplied examples or brand guidance. Use when the user wants polished written content longer than a paragraph, especially when voice consistency, structure, and credibility matter.

affaan-m/ECC · 57 tokens

deploy-docker-compose

Run the Omnigent server as a Docker compose stack (server + Postgres) on any Docker host — your laptop, a VPS, EC2 by hand, or as the base layer of any container-platform deploy. Invoke when the user wants to build the image, bring up the compose stack, debug the stack on a host they already have, or extend the stack…

omnigent-ai/omnigent · 84 tokens

printing-press-import

Bring a published CLI from the public library into the internal library so it's identical to a freshly-generated copy — module path reverted, manuscripts placed alongside, ready for /printing-press-polish or /printing-press-emboss. Use when the public library has a CLI you don't have locally, or to recover from a…

mvanhorn/cli-printing-press · 104 tokens

readme-writer