Which programming languages does it support?

It is language-agnostic and identifies project metadata by scanning common manifests like package.json, pyproject.toml, Cargo.toml, and go.mod.

Does this skill overwrite my custom README formatting?

No, the skill is designed to perform targeted edits using the Edit tool, preserving your existing style, headers, and badge patterns unless the file is significantly broken.

What happens if I don't have a README file yet?

If no README is detected, the skill automatically triggers the 'make-readme' skill to generate a comprehensive document from scratch.

How does it know which features to add?

It analyzes your git commit history since the last README update and cross-references your CHANGELOG.md to identify user-visible changes and new capabilities.

Update README

Name: Update README
Author: gupsammy

bygupsammy

•

内容管理

Refreshes and synchronizes existing README files with the current codebase state, git history, and project changelog.

The Update README skill automates the tedious task of keeping project documentation accurate. It employs three specialized agents in parallel to audit existing content for staleness, scan the codebase for structural changes, and analyze git history for new features since the last update. By integrating directly with your changelog, it ensures that version numbers, badges, and feature lists are always current, applying targeted edits that preserve your original formatting and style while filling in missing essential sections.

主要功能

01Feature extraction from git logs to populate documentation updates

0252 GitHub stars

03Automatic identification and generation of missing standard sections

04Automated version and shield.io badge synchronization

05Smart detection and cleanup of stale content and placeholders

06Parallel audit of documentation, codebase structure, and git history

使用场景

01Cleaning up stale paths, commands, and placeholders in an aging project

02Synchronizing documentation immediately after a new version release

03Standardizing documentation across repositories by adding missing sections like Contributing or License

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add gupsammy/claudest update-readme

For use in Claude.ai and ChatGPT

Download Skill