New: 98,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Agent skill

Update Readme

by athola in athola/claude-night-market

Refreshes README structure favoring concision (an index, not a manual).

MITAuto-check passedDevelopment

Install Update Readme

skills CLI
$ npx skills add athola/claude-night-market --skill update-readme -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install athola/claude-night-market update-readme --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/athola/claude-night-market.git skills-src && mkdir -p .claude/skills && cp -r skills-src/plugins/sanctum/skills/update-readme .claude/skills/update-readme && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
update-readme
GitHub stars
341
Token cost
~2k tokens
SKILL.md length
991 words
Files
3
Skills in repo
154
Repo updated
First seen
Licence
MIT

At a glance

Refreshes README structure favoring concision (an index, not a manual).

  • Works in 6 steps: Language Audit… → Exemplar Research… → Outline Alignment… → …
  • The README needs a structural update after significant project changes
  • SKILL.md covers When To Use, When NOT To Use, Required TodoWrite Items and Step 1 - Language Audit…, plus 7 more sections
  • Calls git, rg and make

What it does

Update Readme is an agent skill from athola/claude-night-market. Refreshes README structure favoring concision (an index, not a manual). Use when the README needs a structural update after significant project changes.

Its SKILL.md is about 2k tokens, which your agent loads only when the skill is triggered. The skill folder holds 3 other files (for example `modules/exemplar-research.md` and `modules/language-audit.md`).

It sits in Development, covering Technical documentation. The repository describes itself as: 23 Claude Code plugins: TDD enforcement hooks, git/PR workflows, spec-driven development, code review, project lifecycle, fix-from-error, maintenance automation, context… The licence is MIT.

When your agent uses it

  • The README needs a structural update after significant project changes
  • Tasks that involve Technical documentation

Example prompts

  • “Use the update-readme skill to refresh README structure favoring concision (an index, not a manual)”
  • “/update-readme”

Workflow steps

6 steps, taken from the step headings in SKILL.md.

  1. Language Audit (update-readme:language-audit)
  2. Exemplar Research (update-readme:exemplar-research)
  3. Outline Alignment (update-readme:outline-aligned)
  4. Apply Edits (update-readme:edits-applied)
  5. 5 - AI Slop Detection (update-readme:slop-scanned)
  6. Verification & Reporting (update-readme:verification-reporting)

What it can do on your machine

Read from SKILL.md and the folder at commit 9f3eb00. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • git
    • rg
    • make

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use git, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Update Readme loads about 2k tokens when it runs. Until then it costs about 42 tokens; SKILL.md has 991 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~42
When it runs · the whole SKILL.md, loaded when a task matches
~2k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from athola/claude-night-market at commit 9f3eb00, republished under its MIT licence (© athola). 991 words, ~2,047 tokens.

Download SKILL.mdSave it as .claude/skills/update-readme/SKILL.md (or your agent's skills folder). This skill also uses 2 other files; get the full folder from GitHub.
name
update-readme
description
Refreshes README structure favoring concision (an index, not a manual). Use when the README needs a structural update after significant project changes.
alwaysApply
false
category
artifact-generation
tags
readme, documentation, exemplars, research, structure
complexity
high
model_hint
deep
estimated_tokens
1200
modules
modules/language-audit.md, modules/exemplar-research.md
progressive_loading
true
dependencies
sanctum:git-workspace-review, imbue:proof-of-work, scribe:slop-detector, scribe:doc-generator

README Update Workflow

When To Use

Use this skill whenever the README requires a structural refresh. Run Skill(sanctum:git-workspace-review) first to capture repo context and diffs.

When NOT To Use

  • Updating inline docs: use doc-updates
  • Consolidating ephemeral reports: use doc-consolidation

Required TodoWrite Items

  1. update-readme:language-audit
  2. update-readme:exemplar-research
  3. update-readme:outline-aligned
  4. update-readme:edits-applied
  5. update-readme:slop-scanned - AI marker detection via scribe
  6. update-readme:verification-reporting

Step 1 - Language Audit (update-readme:language-audit)

  • Confirm pwd, git status -sb, and the baseline branch for reference.
  • Detect dominant languages using repository heuristics (manifest files, file counts).
  • Note secondary languages that influence documentation (e.g., a TypeScript frontend and a Rust backend) so the README can surface both.
  • Record the method and findings.

See modules/language-audit.md for detailed detection patterns and commands.

Step 2 - Exemplar Research (update-readme:exemplar-research)

  • For each primary and secondary language, use web search to locate high-quality READMEs (star count, recency, maintainer activity).
  • Capture 2-3 exemplar repositories per language and summarize why each is relevant (section order, visuals, quickstart clarity, governance messaging, math exposition, etc.).
  • Store citations for every exemplar so the final summary references them explicitly.

See modules/exemplar-research.md for search query patterns and evaluation criteria.

Step 3 - Outline Alignment (update-readme:outline-aligned)

The README is an index, not a manual. Lead with what the project is, how to install it, and a scannable table of its units (plugins, commands, packages); link out for everything else.

A README is a newcomer document. Its reader has never seen this project, so the test for every candidate section is whether that reader needs it before they can install and run one thing. Rationale, alternatives considered, and internals are expert material: extract them to docs/deep-dive/<topic>.md or the book/, linked from the README in one line naming who the page is for. Never delete them to shorten the README. Tier table and cut test: scribe:slop-detector module audience-targeting.md.

A README that declares a different tier (an internal tool whose only readers already run it) says so in its lead.

When this repo's root README was simplified in 2026, it dropped from 435 to 200 lines (65% fewer words) by deleting inlined depth and linking to book/ instead. Aim for that shape, not a section-by-section coverage sweep.

  • Compare current README headings (rg -n '^#' README.md) against the exemplars from Step 2. Lean marketplace and CLI-tool READMEs (asdf-vm/asdf-plugins, ohmyzsh/ohmyzsh, ryoppippi/ccusage) are index-shaped: prose intro under ~500 words, a unit table doing the work, depth behind links.
  • Keep only the sections that earn a place in an index: a one-line value proposition, one install path, a compact command or unit table, a short "what's inside" summary, a single Documentation link section, and metadata (requirements, contributing, license) last. For every other candidate section ask: does this belong in the README, or behind a link?
  • Default to linking out. Send deep architecture, FAQ, roadmap, changelog, alternate install methods, and per-unit detail to their own pages. Per-unit docs live with the unit (hub-and-spoke), never duplicated in the root.
  • Order signals priority: title and tagline first, then install, then the index table, then a short feature summary, then Documentation links, with housekeeping (requirements, contributing, license) last.
  • Map internal documents (docs/, book/, specs/, commands/) to the section that links them, so the README anchors depth without restating it.

Soft budget: a marketplace or collection root README runs roughly 150-400 lines of prose plus any index table. A section that grows over time (roadmap, FAQ, changelog) belongs in a linked page, not the README.

Show full SKILL.md (426 more words)Show less

Step 4 - Apply Edits (update-readme:edits-applied)

  • Implement the new structure directly in README.md (or the specified file).
  • Follow Skill(leyline:markdown-formatting) conventions: wrap prose at 80 chars (prefer sentence/clause boundaries), blank lines around headings, ATX headings only, blank line before lists, reference-style links for long URLs.
  • Maintain concise, evidence-based prose; avoid marketing fluff.
  • Prefer deletion and linking over inlining. If a section duplicates a docs page, cut it and link the page; if it grows over time, move it out of the README entirely.
  • Add comparison tables, feature lists, or diagrams only if they originate from current repository assets (no speculative content).
  • When referencing algorithms or performance claims, point to benchmarks or tests within the repository or documented math reviews.

Step 4.5 - AI Slop Detection (update-readme:slop-scanned)

Run Skill(scribe:slop-detector) on the updated README to detect AI-generated content markers.

Scribe Integration

The scribe plugin provides AI slop detection:

Skill(scribe:slop-detector) --target README.md

This detects:

  • Tier 1 words: delve, tapestry, comprehensive, leveraging, etc.
  • Phrase patterns: "In today's fast-paced world", "cannot be overstated"
  • Structural markers: Excessive em dashes, bullet overuse, sentence uniformity
  • Marketing language: "enterprise-ready", "cutting-edge", "seamless"
Remediation

If slop score exceeds 2.0 (moderate), apply Skill(scribe:doc-generator) principles:

  1. Ground every claim with specifics
  2. Remove formulaic openers/closers
  3. Use numbers, commands, filenames over adjectives
  4. Balance bullets with narrative prose
  5. Show authorial perspective (trade-offs, reasoning)

For significant cleanup needs, use:

Agent(scribe:doc-editor) --target README.md

Step 5 - Verification & Reporting (update-readme:verification-reporting)

  • Re-read the updated README for clarity, accessibility (section lengths, bullet balance), and accurate links.
  • Run git diff README.md (or the edited file) and capture snippets for the final report.
  • Summarize detected languages, exemplar sources (with citations), key structural decisions, and follow-up TODOs (e.g., add badges, upload diagrams).

Exit Criteria

  • All TodoWrite items are complete.
  • The README is index-shaped: prose intro within the soft budget (roughly 150-400 lines plus any unit table), one install path, and a scannable unit/command table.
  • No README section duplicates a book/ or docs/ page; depth is linked, not inlined (rg -n '^#' README.md headings each map to a section that earns a place in an index).
  • The README serves a newcomer, or declares the tier it serves instead in its lead.
  • Content cut for tier fit landed in a linked page, not the bin (docs/deep-dive/ or book/).
  • The README references internal docs and external exemplars with citations.
  • Research notes and command references are captured so future reviewers can reproduce the process.

Troubleshooting

Common Issues

Documentation out of sync Run make docs-sync-check to verify the capabilities docs still match the plugin registrations

Build failures Check that all required dependencies are installed

Links broken Verify relative paths in documentation files

© athola, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 2 other files in plugins/sanctum/skills/update-readme of athola/claude-night-market.

  • SKILL.md
  • modules/exemplar-research.md
  • modules/language-audit.md

Open the folder on GitHubat commit 9f3eb00

Compare with similar skills

Update Readme next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Update Readme compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Update Readme this skillathola/claude-night-market341—~2kAutomated safety check: PassMIT
Diagram Designcathrynlavery/diagram-design47k1 repos~7.5kAutomated safety check: PassMIT
Simple Englishmoeru-ai/airi50k2 repos~4.6kAutomated safety check: PassMIT
Doc SyncJetBrains/ideavim10k2 repos~2.6kAutomated safety check: PassMIT
Mailspring App ScreenshotsFoundry376/Mailspring18k—~1.5kAutomated safety check: PassGPL-3.0
Draw.io Diagram StudioAgents365-ai/drawio-skill10k—~2.4kAutomated safety check: NotesMIT

Similar skills

  • Diagram Design

    cathrynlavery/diagram-design

    Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.

    47k GitHub starsUsed in 1 repo~7.5k tokens
    DevelopmentAuto-check passed

  • Simple English

    moeru-ai/airi

    Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.

    50k GitHub starsUsed in 2 repos~4.6k tokens
    DevelopmentAuto-check passed

  • Doc Sync

    JetBrains/ideavim

    Official

    Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.

    10k GitHub starsUsed in 2 repos~2.6k tokens
    DevelopmentAuto-check passed

  • Mailspring App Screenshots

    Foundry376/Mailspring

    Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.

    18k GitHub stars~1.5k tokensUpdated today
    DevelopmentAuto-check passed

  • Draw.io Diagram Studio

    Agents365-ai/drawio-skill

    Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.

    10k GitHub stars~2.4k tokensUpdated 6 days ago
    DevelopmentAuto-check: notes

  • Dark Architecture Diagram Builder

    Cocoon-AI/architecture-diagram-generator

    Creates dark-themed system, cloud, security and network architecture diagrams as self-contained HTML files with inline SVG and CSS.

    7.4k GitHub starsUsed in 1 repo~2.1k tokens
    DevelopmentAuto-check passed

More from athola/claude-night-market

All 154 skills in this repo

  • Night Market Diagnostics Toolkit

    athola/claude-night-market

    Run and interpret repo diagnostic scripts (ratchets, validators, token stats).

    341 GitHub stars~3.4k tokensUpdated 3 days ago
    Auto-check passed

  • Skills Eval

    athola/claude-night-market

    Evaluate Claude skill quality through auditing. An agent skill from athola/claude-night-market.

    341 GitHub stars~1.6k tokensUpdated 3 days ago
    Auto-check passed

  • Agent Teams

    athola/claude-night-market

    Coordinates Claude agent teams via filesystem protocol. An agent skill from athola/claude-night-market.

    341 GitHub stars~2.5k tokensUpdated 3 days ago
    Auto-check passed

  • Delegation Core

    athola/claude-night-market

    Delegates execution to eight CLIs (Gemini, Qwen, MiniMax, GLM, Muse, Codex, OpenCode, Glimmer).

    341 GitHub stars~2.5k tokensUpdated 3 days ago
    Auto-check passed

  • Elegant Code

    athola/claude-night-market

    Guide minimal code via a decision ladder with full safety, edge, and negative-case coverage.

    341 GitHub stars~2.1k tokensUpdated 3 days ago
    Auto-check passed

  • Skill Library Mission

    athola/claude-night-market

    Build a project skill library in .claude/skills/ via discovery, parallel authoring, and review.

    341 GitHub stars~1.6k tokensUpdated 3 days ago
    Auto-check passed

Categories

Questions about Update Readme

What does Update Readme do?

Refreshes README structure favoring concision (an index, not a manual). Update Readme is an agent skill from athola/claude-night-market. Refreshes README structure favoring concision (an index, not a manual).

When should I use Update Readme?

Update Readme fits situations like: the README needs a structural update after significant project changes; tasks that involve Technical documentation.

How do I install Update Readme in Claude Code?

Run `npx skills add athola/claude-night-market --skill update-readme -a claude-code`. Or copy the skill folder (plugins/sanctum/skills/update-readme in athola/claude-night-market) into .claude/skills/update-readme in your project. Claude Code loads it when a task matches its description.

How do I install Update Readme in Codex?

Run `npx skills add athola/claude-night-market --skill update-readme -a codex`. Or copy the skill folder (plugins/sanctum/skills/update-readme in athola/claude-night-market) into .agents/skills/update-readme in your project. Codex loads it when a task matches its description.

Can I use Update Readme in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add athola/claude-night-market --skill update-readme -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/update-readme, .gemini/skills/update-readme, .github/skills/update-readme and .opencode/skills/update-readme in your project.

What does Update Readme need to run?

Going by SKILL.md and its folder, Update Readme needs the command-line tools its instructions call (git, rg and make).

Does Update Readme access the network?

SKILL.md contains no URLs. Its commands use git, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Update Readme safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Update Readme use?

Update Readme is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Update Readme use?

About 2k tokens (SKILL.md is roughly 8.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Update Readme?

Skills that share tags, products or a category with Update Readme: Diagram Design (cathrynlavery/diagram-design, 47k stars), Simple English (moeru-ai/airi, 50k stars), Doc Sync (JetBrains/ideavim, 10k stars) and Mailspring App Screenshots (Foundry376/Mailspring, 18k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Update Readme?

athola (a GitHub user) maintains it in athola/claude-night-market, which has 341 GitHub stars. The repository holds 154 skills in this directory. The repository was last updated on October 6, 2026.

Source: athola/claude-night-market on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.