diff --git a/README.md b/README.md index 13273a7..f4813f3 100644 --- a/README.md +++ b/README.md @@ -34,8 +34,58 @@ Agent Skills solve this by giving AI assistants **expert-level WordPress knowled | **wp-playground** | WordPress Playground for instant local environments | | **wpds** | WordPress Design System | +## How It Works + +Each skill is a self-contained folder with instructions, references, and optional scripts: + +``` +skills/wp-block-development/ +├── SKILL.md # Main instructions (when to use, procedure, verification) +├── references/ # Deep-dive docs on specific topics +│ ├── block-json.md +│ ├── deprecations.md +│ └── ... +└── scripts/ # Deterministic helpers (detection, validation) + └── list_blocks.mjs +``` + +When you ask your AI assistant to work on WordPress code, it reads these skills and follows the documented procedures rather than guessing. + + +## Global vs. Project Scope + +Skills can be installed in two scopes: + +**Global** — installed in your home directory (e.g. `~/.claude/skills/`, `~/.cursor/skills/`). +- Available across **all** your projects automatically. +- Best for individual developers who want WordPress knowledge in every repo. + +**Project** — installed inside a repository (e.g. `.claude/skills/`, `.github/skills/`, `.cursor/skills/`). +- Available only within **that specific project**. +- Can be committed to version control so the entire team benefits. + +You can use both at the same time. When a skill exists in both scopes, the project-level version is used. + ## Quick Start +The fastest way to install skills is with a single command: + +```bash +npx skills add WordPress/agent-skills --skill wp-plugin-development +``` + +To see all available skills: + +```bash +npx skills add WordPress/agent-skills --list +``` + +To install multiple skills at once: + +```bash +npx skills add WordPress/agent-skills --skill wp-plugin-development wp-abilities-api wp-playground +``` + ### Install globally for Claude Code ```bash @@ -100,23 +150,6 @@ node shared/scripts/skillpack-install.mjs --dest=../my-repo --targets=claude,cur Copy any skill folder from `skills/` into your project's instructions directory for your AI assistant. -## How It Works - -Each skill contains: - -``` -skills/wp-block-development/ -├── SKILL.md # Main instructions (when to use, procedure, verification) -├── references/ # Deep-dive docs on specific topics -│ ├── block-json.md -│ ├── deprecations.md -│ └── ... -└── scripts/ # Deterministic helpers (detection, validation) - └── list_blocks.mjs -``` - -When you ask your AI assistant to work on WordPress code, it reads these skills and follows the documented procedures rather than guessing. - ## Compatibility - **WordPress 6.9+** (PHP 7.2.24+)