updating-readme

Update your README by applying targeted changes to existing sections when dependencies, environment variables, or configuration options change. This Skill applies minimal, style-preserving updates to README.md files while maintaining the original structure and integrating with tools like check-readme.py.

Yes. This Skill detects when dependencies are added and automatically updates the relevant README sections with version numbers and prerequisites inline, preserving your documentation style while keeping it aligned with your project state.

Use trigger-aware maintenance to detect when code changes require documentation updates. This Skill applies small, targeted updates to README.md after changes like new environment variables or configuration options, then flags when a full rewrite is needed.

Yes. The Skill updates version numbers and prerequisites inline within existing README.md sections, applying minimal changes that preserve the original formatting and structure while keeping documentation current.

Use targeted updates for incremental changes like adding dependencies, changing environment variables, or updating configuration notes. This Skill handles these cases while guiding you to a higher-fidelity writing tool when the README requires a complete restructuring.

Yes. This Skill integrates with tools such as check-readme.py to verify whether your README documentation aligns with your current project state and flags sections that need updates.