/readme-review

Review the README.md to ensure it functions as an executable contract for new developers.

yeaight7@yeaight7

GitHub

From plugin

agent-powerups

654 skills46 agents54 commands

Install

$ npx -y skills add yeaight7/agent-powerups --agent claude-code

How it fires

How this command gets triggered: by you, by Claude, or both.

Fires itselfClaude auto-loads it when your prompt matches the work.
You can call itInvoke it directly when you want it.
Slash command/readme-review

Context preview

What this command does when you run it.

Review the README.md to ensure it functions as an executable contract for new developers.

Command definition

readme-review.md

description: "Review the README.md to ensure it functions as an executable contract for new developers."
argument-hint: "<path/to/readme>"

README Review Command

CRITICAL BEHAVIORAL RULES

1. **Assume Zero Context**: Review the file assuming the reader knows nothing about the stack or the project history.

Execution Steps

1. Read the target README file. 2. Check for a clear statement of purpose. 3. Check for a `.env` or configuration setup section. 4. Check for an exact, copy-pasteable build/install command. 5. Check for an exact, copy-pasteable test command. 6. If any are missing or ambiguous, output a diff to fix the README immediately.

Read it on GitHub ↗

Ships withagent-powerups

Curated power-ups for coding agents: skills, slash commands, MCP configs, hooks, AGENTS.md templates, and workflows for serious software engineering. Claude Code, Codex, Antigravity CLI, Cursor and more

Get the whole plugin, auto-invoked

Stats

Python TypeScript JavaScript Node HTML

+7 tags

SQL Git GitHub Markdown Anthropic Gemini MCP

Stars

Views

Forks

Active

Maintenance

TypeScript

Language