readme-writing

readme-writing is a skill for Claude Code from HigorAlves/orc. It costs 43 tokens per session (340 once invoked), scanned A, a copy of create-readme, MIT.

A guide for creating a project README, the Markdown file that explains what a software project does and how to use it.

In plain words
What is it for?
Use it to create, improve, or regenerate a README after reviewing the project.
Why use it?
It helps turn an unfamiliar codebase into clear setup and usage instructions without overlooking important details.

Skill for Claude Code

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

Part of the orc plugin — 80 skills, 30 commands, 14 agents, 5 hooks shipped together

Good fit Use it to create, improve, or regenerate a README after reviewing the project.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/higoralves/orc/readme-writing
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 HigorAlves/orc --skill readme-writing
Clone the repo
git clone --depth 1 https://github.com/HigorAlves/orc

Made for: Claude Code.

Or install orc, the plugin that ships this one along with the rest of its 80 skills, 30 commands, 14 agents, 5 hooks.

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-writing

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/higoralves/orc/readme-writing"><img src="https://agentmods.dev/badge/skills/higoralves/orc/readme-writing.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 43 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 340 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 88% copy Near-identical to another mod 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.00043 $0.00340
Opus 5 $0.00022 $0.00170
Sonnet 5 $0.00009 $0.00068
Haiku 4.5 $0.00004 $0.00034

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

Security

Grade A, and why

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

This is a copy

88% identical to create-readme — 4 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

orc/skills/readme-writing/SKILL.md · 22 lines

What it actually says

Role

You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read.

Task

  1. Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
  2. Take inspiration from these readme files for the structure, tone and content:
  3. Do not overuse emojis, and keep the readme concise and to the point.
  4. Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
  5. Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
  6. If you find a logo or icon for the project, use it in the readme's header.
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 First seen · 22 lines · 43 tokens per session scan A c4717ae37a76

Subscribe to this mod's changes

readme-writing is a skill published in the GitHub repository HigorAlves/orc (6 stars, last pushed 14d ago), licensed MIT. It adds 43 tokens to every session and 340 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. It is 88% identical to create-readme, differing in 4 lines, and is treated as a copy.

Related

Other skills, from other repositories