Claude Code Plugins

Community-maintained marketplace

Feedback

update-readme

@athola/claude-night-market
8
0

Consolidate README content using language-aware exemplars, internal doc linkage, and reproducible evidence.

Install Skill

1Download skill
2Enable skills in Claude

Open claude.ai/settings/capabilities and find the "Skills" section

3Upload to Claude

Click "Upload skill" and select the downloaded ZIP file

Note: Please verify skill by going through its instructions before using it.

SKILL.md

name update-readme
description Consolidate README content using language-aware exemplars, internal doc linkage, and reproducible evidence.
category artifact-generation
tags readme, documentation, exemplars, research, structure
tools Read, Write, Edit, Bash, WebSearch, TodoWrite
complexity high
estimated_tokens 1200
modules language-audit, exemplar-research
progressive_loading true
dependencies sanctum:shared, sanctum:git-workspace-review, imbue:evidence-logging

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.

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: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)

  • Compare current README headings (rg -n '^#' README.md) against patterns observed in exemplars.
  • Draft a target outline covering: value proposition, installation, quickstart, deeper usage/configuration, architecture/feature highlights, performance or math guarantees, documentation links, contribution/governance, roadmap/status, and licensing/security notes.
  • Ensure internal documents (docs/, specs/, wiki, commands/) are mapped to the relevant sections so the README anchors them with context-sensitive links.

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

  • Implement the new structure directly in README.md (or the specified file).
  • Maintain concise, evidence-based prose; avoid marketing fluff.
  • 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 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 reflects a modern, language-aware structure, referencing both internal docs and external inspiration with citations.
  • Research notes and command references are captured so future reviewers can reproduce the process.