create-readme-section

A command for writing one requested section of a README, the guide file that explains a software project.

In plain words
What is it for?
Use it for installation, usage, API reference, contributing, configuration, troubleshooting, testing, deployment, and other README sections.
Why use it?
It helps produce a focused, well-organized section without having to write the whole README at once.

Command for Claude Code

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.

agentmods
npx agentmods add commands/centminmod/my-claude-code-setup/create-readme-section
Clone the repo
git clone --depth 1 https://github.com/centminmod/my-claude-code-setup

Made for: Claude Code.

Per session 0 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 491 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
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 $0.00000 $0.00491
Opus 5 $0.00000 $0.00246
Sonnet 5 $0.00000 $0.00098
Haiku 4.5 $0.00000 $0.00049

Measured 2d ago against content hash 4c1bbfe4a2b1, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

create-readme-section 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 2d 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.

.claude/commands/documentation/create-readme-section.md · 73 lines

How it starts

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

Create README Section

Generate a specific section for a README file based on the user's request. This command helps create well-structured, professional README sections that follow best practices.

Usage Examples

Basic Usage

"Create an installation section for my Python project" "Generate a contributing guide section" "Write an API reference section for my REST endpoints"

Specific Sections

  • Installation: Step-by-step setup instructions
  • Usage: How to use the project with examples
  • API Reference: Detailed API documentation
  • Contributing: Guidelines for contributors
  • License: License information
  • Configuration: Configuration options and environment variables
  • Troubleshooting: Common issues and solutions
  • Dependencies: Required dependencies and versions
  • Architecture: High-level architecture overview
  • Testing: How to run tests
  • Deployment: Deployment instructions
  • Changelog: Version history and changes

Instructions for Claude

When creating a README section:

  1. Analyze the Project Context: Look at existing files (package.json, requirements.txt, etc.) to understand the project
  2. Follow Markdown Best Practices: Use proper headings, code blocks, and formatting
  3. Include Practical Examples: Add code snippets and command examples where relevant
  4. Be Comprehensive but Concise: Cover all important points without being verbose
  5. Match Existing Style: If a README already exists, match its tone and formatting style

Section Templates

Installation Section
  • Prerequisites
  • Step-by-step installation
  • Verification steps
  • Common installation issues
Usage Section
  • Basic usage examples
  • Advanced usage scenarios
  • Command-line options (if applicable)
  • Code examples with expected output
API Reference Section
  • Endpoint descriptions
  • Request/response formats
  • Authentication details
  • Error codes and handling
  • Rate limiting information
Contributing Section
  • Development setup
  • Code style guidelines
  • Pull request process
  • Issue reporting guidelines
  • Code of conduct reference

Read the full file on GitHub · 73 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. 2d ago First seen · 73 lines · 0 tokens per session scan A 4c1bbfe4a2b1

Subscribe to this mod's changes

create-readme-section is a command published in the GitHub repository centminmod/my-claude-code-setup (2,614 stars, last pushed 1mo ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 491 tokens. 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-30.