How do I install the Review Readme skill?

Run npx skillmds@latest add tomevault-io/review-readme in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Review Readme safe to use?

This skill has not completed SkillMD's automated safety review yet. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Review Readme?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Review Readme free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Review Readme?

tomevault-io (@tomevault-io) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Review Readme by tomevault-io — Agent Skill

Name: Review Readme
Author: tomevault-io

Review Readme

檢查 README.md 是否需要根據最近的 commits 更新。Use when the user wants to review whether README.md is up-to-date with recent code changes. Triggers on requests like "review readme", "check readme", "檢查 README", "更新 README", or when the user invokes /review-readme. Analyzes all commits since the last README.md modification and suggests specific updates if needed. Use when this capability is needed.

tomevault-io Updated Sep 17, 2026

File contents

Review README

Analyze commits since the last README.md modification and determine whether README.md needs updating.

Workflow

Find the last README.md commit

git log -1 --format="%H %s" -- README.md

List all commits since that point
```
git log <last-readme-commit>..HEAD --oneline --no-merges
```
If no commits exist, report "README.md is up-to-date" and stop.
Analyze each commit for README-relevance Review diffs (git show <hash> --stat and git show <hash> as needed). Flag changes that affect README.md:
- New or removed features / generation modes
- New or changed commands (npm run ...)
- New dependencies or prerequisites
- Architecture changes (new composables, stores, workers, routes)
- Changed API / configuration patterns
- New environment variables or setup steps
Report findings in zh-TW Present a structured summary:
- 相關 commits: Commits that may require README updates, with brief reason
- 建議修改: For each, describe the specific README section(s) to update and the proposed change
- 無需修改: Commits confirmed irrelevant (bug fixes, style tweaks, test-only, etc.)
Confirm and apply Ask the user to confirm the proposed changes before editing README.md. After confirmation, apply edits and show a summary of what was changed.

Converted and distributed by TomeVault — claim your Tome and manage your conversions.

---name: review-readmedescription: 檢查 README.md 是否需要根據最近的 commits 更新。Use when the user wants to review whether README.md is up-to-date with recent code changes. Triggers on requests like "review readme", "check readme", "檢查 README", "更新 README", or when the user invokes /review-readme. Analyzes all commits since the last README.md modification and suggests specific updates if needed. Use when this capability is needed.---# Review READMEAnalyze commits since the last README.md modification and determine whether README.md needs updating.## Workflow1. **Find the last README.md commit** ```bash git log -1 --format="%H %s" -- README.md ```2. **List all commits since that point** ```bash git log <last-readme-commit>..HEAD --oneline --no-merges ``` If no commits exist, report "README.md is up-to-date" and stop.3. **Analyze each commit for README-relevance** Review diffs (`git show <hash> --stat` and `git show <hash>` as needed). Flag changes that affect README.md: - New or removed features / generation modes - New or changed commands (`npm run ...`) - New dependencies or prerequisites - Architecture changes (new composables, stores, workers, routes) - Changed API / configuration patterns - New environment variables or setup steps4. **Report findings in zh-TW** Present a structured summary: - **相關 commits**: Commits that may require README updates, with brief reason - **建議修改**: For each, describe the specific README section(s) to update and the proposed change - **無需修改**: Commits confirmed irrelevant (bug fixes, style tweaks, test-only, etc.)5. **Confirm and apply** Ask the user to confirm the proposed changes before editing README.md. After confirmation, apply edits and show a summary of what was changed.---> Converted and distributed by [TomeVault](https://tomevault.io/claim/nathanfhh) — claim your Tome and manage your conversions.

Frequently asked questions