readme-asynclisted

## Installation ### Via npm/npx (recommended) ```bash # Install globally, then run anywhere npm install -g @skills-collection/readme-async readme-async [target-project-path] # Or run directly without installing npx @skills-collection/readme-async [target-project-path] ``` ### Via script (from cloned repo) ```bash # From the skill source directory ./scripts/install.sh [target-project-path] # Or on Windows PowerShell .\scripts\install.ps1 [target-project-path] ``` All methods copy the skill to `<target-project>/.claude/skills/readme-async/`. # README Sync ## Purpose Keep `README.md` synchronized with the actual state of the project. The README must describe **what the project currently does**, not what it used to do. The codebase and project configuration are the source of truth. ## When to run Run this skill after changes that may affect the project's public or developer-facing documentation, including: * New or removed features * Changed behavior * Installation or setup changes * Dependency changes * Configuration changes * Environment variables * CLI commands or scripts * API endpoints or parameters * Project structure or architecture * Development workflows * Build or deployment processes * New prerequisites * Important limitations It can also be run explicitly by the user at any time. ## Core workflow ### 1. Inspect the current project First inspect the repository and identify the relevant sources of truth. Check files that exist, such as: ```text READ