AgentSkillsCN

update-readme

更新 README.md,以反映项目的当前状态。

SKILL.md
--- frontmatter
name: update-readme
description: Update README.md to reflect the current state of the project

Update README

Analyze the current state of the project and update README.md to reflect the latest status.

Instructions

  1. Analyze the entire project:

    • Directory structure
    • Key files and their roles
    • Technology stack in use
    • Dependencies (package.json, requirements.txt, etc.)
  2. Review current README.md:

    • Read existing content
    • Identify outdated or incorrect information
    • Identify missing information
  3. README.md update content:

    • Project overview
    • Setup instructions
    • Usage guide
    • Directory structure
    • Technology stack
    • Development environment requirements
    • Build and deployment procedures
    • Testing methods
    • Contributing guidelines (if CONTRIBUTING.md doesn't exist)
  4. Update rules:

    • Write in clear and concise English or Japanese
    • Add appropriate language tags to code blocks
    • Update badges (CI/CD, coverage, etc.) appropriately
    • Verify that links are valid
    • Ensure instructions actually work

Format Guidelines

  • Use proper heading hierarchy
  • Include working command examples
  • Include sample values for environment variables
  • Suggest removal or update of outdated screenshots