readme-generator

readme-generator is a skill for Claude Code from serejaris/personal-corp-os. It costs 37 tokens per session (1,138 once invoked), scanned A, original, MIT.

A tool for creating or rewriting a project's README.md, the main guide that explains a repository to people. It researches the project, identifies its type, and structures the documentation around human readers.

In plain words
What is it for?
Use it when starting a README, replacing an old one, explaining a project's architecture and commands, or preparing documentation for contributors and users.
Why use it?
It reduces the work of turning a codebase into clear setup, usage, and project documentation, especially when an existing README is outdated or missing.

Skill for Claude Code

Written for Claude Code: shipped in a Claude Code plugin. Also seen: mentions CLAUDE.md; mentions Claude Code.

Part of the personal-corp-os plugin — 33 skills shipped together

Good fit Use it when starting a README, replacing an old one, explaining a project's architecture and commands, or preparing documentation for contributors and users.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/serejaris/personal-corp-os/readme-generator
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 serejaris/personal-corp-os --skill readme-generator
Clone the repo
git clone --depth 1 https://github.com/serejaris/personal-corp-os

Made for: Claude Code.

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

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/serejaris/personal-corp-os/readme-generator"><img src="https://agentmods.dev/badge/skills/serejaris/personal-corp-os/readme-generator.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 37 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,138 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. Third-party audits
  • NVIDIA SkillSpector pass 7 Sept 2026
How audits are shown
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.00037 $0.01138
Opus 5 $0.00018 $0.00569
Sonnet 5 $0.00007 $0.00228
Haiku 4.5 $0.00004 $0.00114

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

Security

Grade A, and why

readme-generator 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-generator/SKILL.md · 206 lines

How it starts

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

README Generator

Generate human-focused README files following current best practices.

Core principle: README is for humans, not agents. Research → Analyze → Write.

Model recommendation: Use Task tool with model: haiku for README generation — faster and cheaper for documentation tasks.

When to Use

  • Creating README for new project
  • Rewriting outdated README
  • User asks "write/create/update README"

Process

digraph readme_flow {
    rankdir=TB;
    "1. Research best practices via Exa" [shape=box];
    "2. Analyze project structure" [shape=box];
    "3. Identify project type" [shape=diamond];
    "4. Write README with appropriate sections" [shape=box];
    "5. Commit and push if requested" [shape=box];

    "1. Research best practices via Exa" -> "2. Analyze project structure";
    "2. Analyze project structure" -> "3. Identify project type";
    "3. Identify project type" -> "4. Write README with appropriate sections";
    "4. Write README with appropriate sections" -> "5. Commit and push if requested";
}

Step 1: Research

Always search first for current README best practices:

mcp__exa__web_search_exa: "best practices README.md {year} {project_type}"

Look for:

  • Current trends in README structure
  • Examples from similar projects
  • What sections are essential vs optional

Step 2: Analyze Project

Read these files to understand the project:

  • CLAUDE.md or existing docs
  • package.json / pyproject.toml / Cargo.toml
  • Main entry points
  • Test files (understand features)

Step 3: Identify Project Type

Type Key Sections
CLI Tool Usage examples, Options table, Installation
Library/SDK API overview, Quick start, Examples
Web App Features, Quick start, Architecture diagram
Full-stack Architecture, Quick start both parts, Tech stack
AI/ML Model info, Requirements (GPU), Examples

Step 4: README Structure

Essential (all projects):

Read the full file on GitHub · 206 lines

Files

What ships with it

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

  1. 11d ago First seen · 206 lines · 37 tokens per session scan A 198a04d31d6b

Subscribe to this mod's changes

readme-generator is a skill published in the GitHub repository serejaris/personal-corp-os (225 stars, last pushed 15d ago), licensed MIT. It adds 37 tokens to every session and 1,138 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-08-30.

Related

Other skills, from other repositories

manuscript-review

Pre-publication manuscript audit producing a section-level refactoring report with citation hygiene and submission-readiness checks. Triggers on: "review my paper", "check before submission", "is this ready to submit", "pre-pub checklist", "refactor my paper", "check my references", "does the abstract work".

Mathews-Tom/armory · 70 tokens

figure-rhetoric

Evaluate whether figures and plots in a manuscript effectively communicate the claims they support. Audits chart-type fit, axis design, visual hierarchy, data density, caption interpretation, perceptual accuracy, and narrative arc across 8 dimensions. Triggers on: "do my figures work", "check my plots", "are my graphs…

Mathews-Tom/armory · 123 tokens

humanize

Detects and removes AI-generated writing patterns while preserving meaning and facts. Triggers on: "humanize text", "make this sound human", "remove AI patterns", "rewrite to sound natural", "make this less AI", "de-slop this", "not sound like ChatGPT", "human pass".

Mathews-Tom/armory · 66 tokens

manuscript-provenance

Computational provenance audit verifying every number, table, and figure in a manuscript derives from code, not manual entry. Triggers on: "check provenance", "verify reproducibility", "audit my pipeline", "are my numbers from code", "provenance audit". Companion to manuscript-review (prose audit).

Mathews-Tom/armory · 70 tokens

code-refiner

Deep code simplification and refactoring preserving behavior across Python, Go, TypeScript, Rust. Targets complexity, anti-patterns, readability debt. Triggers on: "simplify this code", "refactor for clarity", "reduce complexity", "make this more readable", "tech debt cleanup", "too much nesting".

Mathews-Tom/armory · 69 tokens

html-presentation

Converts documents, outlines, or notes into self-contained HTML slide decks with horizontal (Reveal.js) or vertical scroll navigation and multiple themes. Triggers on: "create a presentation", "slide deck", "pitch deck", "HTML presentation", "web-based slides", "reveal.js deck", "convert document into slides".

Mathews-Tom/armory · 70 tokens