writing-readme

writing-readme is a skill for Claude Code from qte77/claude-code-plugins. It costs 48 tokens per session (899 once invoked), scanned A, original, Apache-2.0.

A README-writing guide for creating or updating documentation for repositories, GitHub user profiles, or organizations.

In plain words
What is it for?
Use it to write README files for Rust, Python, Node.js, Go, and other repositories, or for GitHub account and organization profiles.
Why use it?
It helps produce documentation that matches the project type and the conventions of its intended location.

Skill for Claude Code

Written for Claude Code: $ARGUMENTS substitution. Also seen: mentions Claude Code; mentions AGENTS.md.

Part of the readme-generator plugin — 2 skills shipped together

Good fit Use it to write README files for Rust, Python, Node.js, Go, and other repositories, or for GitHub account and organization profiles.

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

Made for: Claude Code.

Or install readme-generator, the plugin that ships this one along with the rest of its 2 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 writing-readme

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/qte77/claude-code-plugins/writing-readme"><img src="https://agentmods.dev/badge/skills/qte77/claude-code-plugins/writing-readme.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 48 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 899 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.00048 $0.00899
Opus 5.5 $0.00019 $0.00360
Sonnet 5.5 $0.00010 $0.00180
Haiku 4.5 $0.00005 $0.00090

Measured 21d ago against content hash 677259c23e84, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

writing-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 21d 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/readme-generator/skills/writing-readme/SKILL.md · 82 lines

How it starts

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

Write README

Scope: $ARGUMENTS

Generate or update a README.md following scope-specific best practices.

Phase 1: Detect Scope

Parse $ARGUMENTS to determine scope:

  • repo (default) — README.md for a code repository in the current directory
  • repo <owner/repo> — README.md for a specific remote repository
  • account <username> — profile README for a GitHub user (<username>/<username>/README.md)
  • org <orgname> — organization profile README (.github/profile/README.md)

If no scope is given, default to repo for the current working directory.

Phase 2: Gather Context

For repo

  1. Read existing README.md (if any)
  2. Detect project type:
    • action.yml / action.yaml exists → GitHub Action
    • pyproject.toml / setup.py → Python library
    • package.json → Node.js/TypeScript
    • Cargo.toml → Rust
    • go.mod → Go
  3. Read project manifest for name, version, description, license
  4. Scan source tree: src/, lib/, main entry points
  5. Read LICENSE file
  6. Check for existing docs: CONTRIBUTING.md, AGENTS.md, docs/

For account

  1. gh api users/<username> — bio, company, location, blog
  2. gh repo list <username> --limit 30 --json name,description,stargazerCount,primaryLanguage — repos sorted by stars
  3. Read existing <username>/<username>/README.md if it exists
  4. Identify top 3-5 repos by stars or recent activity

For org

  1. gh api orgs/<orgname> — description, blog, location
  2. gh repo list <orgname> --limit 50 --json name,description,isPrivate,stargazerCount,primaryLanguage — public repos
  3. Read existing .github/profile/README.md or .github/readme.md
  4. Group repos by domain/purpose
  5. Identify pinned repos if any

Phase 3: Apply Template

See references/readme-templates.md for the four template snippets and per-scope conventions (GitHub Action, Library/Application, Account, Organization). Repo READMEs follow the qte77 doc-structure canon: value-first order Hero → Badges → What → How → Why → Refs → License → tail; badges License → Version → CI (static blue / native status, Version linked to CHANGELOG.md).

Read the full file on GitHub · 82 lines

Files

What ships with it

1 file 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. 21d ago Changed · +2 lines 677259c23e84
  2. 1mo ago First seen · 80 lines · 48 tokens per session scan A 44b2cd67f8d2

Subscribe to this mod's changes

writing-readme is a skill published in the GitHub repository qte77/claude-code-plugins (3 stars, last pushed 4d ago), licensed Apache-2.0. It adds 48 tokens to every session and 899 once invoked, about $0.0002 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-09-03.

Related

Other skills, from other repositories

android-kotlin-compose

Android development with Kotlin and Jetpack Compose. Use when user mentions "Compose", "Jetpack Compose", "Material3", "Hilt", "Room", "ViewModel", or needs to build Android UI, implement MVVM architecture, manage Compose state, or integrate Jetpack libraries (Navigation, Room, Hilt, ViewModel). Triggers on…

and3r817/dot-claude-plugins · 84 tokens

android-kotlin-coroutines

Android development with Kotlin Coroutines and Flow. Use when user mentions "coroutines", "suspend", "Flow", "StateFlow", "SharedFlow", "viewModelScope", "lifecycleScope", or needs to implement async programming, handle structured concurrency, integrate coroutines with Retrofit/Room/WorkManager, or write coroutine…

and3r817/dot-claude-plugins · 87 tokens

codex-advisor

Advisory consultation skill for architectural reviews, design decisions, code analysis, and technology evaluation. Codex provides recommendations without making code changes. Invoked by phrases like "consult Codex", "get Codex's opinion", "ask Codex about", "have Codex review", "Codex analysis", "validate this…

and3r817/dot-claude-plugins · 85 tokens

ast-grep

Structural code search and rewriting using AST patterns. Use when user mentions "ast-grep", "sg", or needs to search codebases using Abstract Syntax Tree patterns, find specific code structures, perform complex queries beyond text search, or rewrite code at scale. Triggers on requests for pattern matching, code…

and3r817/dot-claude-plugins · 75 tokens

github-cli

This skill should be used when working with GitHub CLI (gh) for repository management, pull requests, issues, API access, GitHub Actions, or automation workflows. Provides comprehensive guidance on gh command patterns, security considerations, and best practices.

and3r817/dot-claude-plugins · 52 tokens

android-analysis

Expert Android and Java reverse engineering for APK/AAR/JAR decompilation and inspection. Use when user mentions "decompile", "jadx", "apktool", "reverse engineer", or needs to analyze Android binaries, unpack libraries, understand obfuscated apps, or extract resources from compiled artifacts.

and3r817/dot-claude-plugins · 63 tokens