SuperAPI AI Directory

readme-updater

Writing & research

View repository

Updated 10-16 09:44

About this skill

README Update Skill

Description

Intelligently update README.md to keep it in sync with the code.

Trigger Conditions

  • "Update README"
  • Invoked by the git-precommit orchestrator
  • After adding important features

Regulatory Basis

  • Constitution: CONSTITUTION.md Article 6

Update Strategy

1. Detect Change Type

  • New feature → Update feature list
  • New dependency → Update installation instructions
  • API change → Update usage examples
  • Structural change → Update project structure

2. Update Sections

Section Condition
Feature list Features added/removed
Installation instructions Dependency changes
Usage examples API changes
Project structure Directory structure changes
Configuration instructions New configuration options

3. Preserve Sections

The following sections are not modified automatically:

  • License information
  • Contribution guidelines
  • Acknowledgements

Output Format

📝 README 更新分析

變更偵測:
  ✅ 新增功能:用戶認證模組
  ✅ 新增依賴:bcrypt

建議更新:
  [功能列表] 新增「🔐 用戶認證」
  [安裝說明] 新增 bcrypt 安裝指令

預覽:
  ## 功能
  - 🤖 Claude Skills
  - 📝 Memory Bank
+ - 🔐 用戶認證(新增)