| 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
-
Analyze the entire project:
- Directory structure
- Key files and their roles
- Technology stack in use
- Dependencies (package.json, requirements.txt, etc.)
-
Review current README.md:
- Read existing content
- Identify outdated or incorrect information
- Identify missing information
-
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)
-
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