create-readme

create-readme is a skill for Claude Code from atman-33/workhub. It costs 34 tokens per session (1,707 once invoked), scanned A, original, MIT.

A skill for creating a comprehensive README.md for a software project. A README is the main guide that explains what a project is, how to use it, and how to contribute.

In plain words
What is it for?
Use it to write or improve documentation for an application, library, command-line tool, template, or open-source project.
Why use it?
It turns an unfamiliar codebase into a structured guide based on the project's actual files and purpose.

Skill for Claude Code

Written for Claude Code: allowed-tools in frontmatter.

Part of the authoring plugin — 5 skills shipped together

Good fit Use it to write or improve documentation for an application, library, command-line tool, template, or open-source project.

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

Made for: Claude Code.

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

agentmods badge for create-readme

README.md
[![agentmods](https://agentmods.dev/badge/skills/atman-33/workhub/create-readme.svg)](https://agentmods.dev/skills/atman-33/workhub/create-readme)
Your own site
<a href="https://agentmods.dev/skills/atman-33/workhub/create-readme"><img src="https://agentmods.dev/badge/skills/atman-33/workhub/create-readme.svg" alt="Measured on agentmods" height="20"></a>
Per session 34 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,707 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.00034 $0.01707
Opus 5 $0.00017 $0.00853
Sonnet 5 $0.00007 $0.00341
Haiku 4.5 $0.00003 $0.00171

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

Security

Grade A, and why

create-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 3d 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.

plugins/authoring/skills/create-readme/SKILL.md · 92 lines

How it starts

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

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

Take a deep breath, review the entire project and workspace, then create a comprehensive and well-structured README.md at the project root.

1. Investigate the project first

Before writing anything, gather the facts the README must reflect:

  • Audience & README type — decide who reads this README and what it must primarily enable, then order the document around that intent:

    • Consumption-focused — users install/run/use the thing as-is (CLI tool, app, plugin/marketplace, service, template). Lead with how to add/install and use it. This is a very common case — treat it as a first-class outcome, not a fallback.
    • Library/integration-focused — developers import it into their own code. Lead with install plus API/usage examples.
    • Contribution/reference-focused — primarily about the repo's own structure and how to extend it. Give repository layout and extension steps prominence.

    Most projects are a blend; pick the dominant intent and order sections around it.

  • Identity & purpose — read existing README.md (refine, don't blindly overwrite), package.json / pyproject.toml / Cargo.toml / go.mod, and top-level docs to learn the name, one-line purpose, and description.

  • How it runs — detect install/build/dev/test commands, entry points, and runtime/version requirements.

  • Features & usage — infer the main capabilities and the primary usage flow (CLI flags, API, config options, env vars) from source and config.

  • Assets — look for an existing logo or icon (e.g. logo.*, icon.*, files under assets/, docs/, .github/). If one exists, use it in the header.

  • Repository — use git remote -v to resolve the repo URL for badges and links.

Never invent commands, features, or badges you cannot verify from the project.

Read the full file on GitHub · 92 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. 3d ago First seen · 92 lines · 34 tokens per session scan A 8abc62bc31f0

Subscribe to this mod's changes

create-readme is a skill published in the GitHub repository atman-33/workhub (2 stars, last pushed 2d ago), licensed MIT. It adds 34 tokens to every session and 1,707 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-09-03.

Related

Other skills, from other repositories

gonavi-cli

Operate databases through the GoNavi headless CLI — the gonavi executable shipped in verified GitHub Release archives. Covers listing/adding/importing saved connections, running SQL queries against saved connections or ad-hoc connection files, exporting result sets to csv/json/md/html/xlsx, batch-executing SQL files…

Syngnat/GoNavi · 144 tokens

xiaohongshu-image-creator

An image-making assistant for Xiaohongshu, a Chinese social platform for lifestyle, product, and educational posts. It creates vertical covers and supporting images matched to the post’s topic, audience, and visual style.

huangrichao2020/pretty-skills · 121 tokens

codex

Run the Codex CLI directly in the user's checkout for code analysis, refactoring, or automated editing without Claude Architect's verified delegation lifecycle.

PyModel/claude-architect · 31 tokens

design

Create a doc-as-code design package from a PRD or SPEC. Conditionally generates C4 diagrams (Context/Container/Component), sequence diagrams, ER diagram + Data Dictionary, OpenAPI 3.0, AsyncAPI 3.0, ADRs, domain glossary, state diagrams, and deployment view as Mermaid-rendered Markdown files. Use when PM mentions…

cryndoc/polisade-orchestrator · 162 tokens

shipyard-handoff

Captures session context into .shipyard/HANDOFF.md so the next session can resume without losing progress.

lgbarn/shipyard · 27 tokens

trellis-spec-bootstrap

Bootstrap project-specific Trellis coding specs with a platform-neutral single-agent workflow. Use when creating or refreshing .trellis/spec guidelines, analyzing a codebase with GitNexus, ABCoder, or source inspection, decomposing package/layer spec work, and writing real codebase-backed spec docs without placeholder…

fy-agent/fyagent · 67 tokens