sd-readme

Community

Syncs package READMEs with latest code changes

Authorkslhunter
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Keeps package README files up to date by reflecting the latest code changes based on commit history.

Core Features & Use Cases

  • Automated README synchronization: analyzes the package's commit history to identify changes that affect the README and updates it accordingly.
  • API & usage documentation guidance: helps document new exports, API changes, and usage examples with consistent formatting.
  • Workflow for updates: provides a repeatable process to review commits and refresh documentation while preserving existing structure.

Quick Start

Provide the package path or name to refresh its README using commit history since the last update.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: sd-readme
Download link: https://github.com/kslhunter/simplysm/archive/main.zip#sd-readme

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.