Skip to content

Commit aa735ea

Browse files
authored
Update README with Skills.sh installation guide (#14)
Added installation instructions for Skills.sh to the README and moved how it works before the installation process.
1 parent 9b1e542 commit aa735ea

1 file changed

Lines changed: 60 additions & 17 deletions

File tree

‎README.md‎

Lines changed: 60 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,68 @@ Agent Skills solve this by giving AI assistants **expert-level WordPress knowled
3838
| **wp-plugin-directory-guidelines** | WordPress Plugin Directory Guidelines |
3939
| **blueprint** | WordPress Playground Blueprints for declarative Playground environment setup |
4040

41+
## How It Works
42+
43+
Each skill is a self-contained folder with instructions, references, and optional scripts:
44+
45+
```
46+
skills/wp-block-development/
47+
├── SKILL.md # Main instructions (when to use, procedure, verification)
48+
├── references/ # Deep-dive docs on specific topics
49+
│ ├── block-json.md
50+
│ ├── deprecations.md
51+
│ └── ...
52+
└── scripts/ # Deterministic helpers (detection, validation)
53+
└── list_blocks.mjs
54+
```
55+
56+
When you ask your AI assistant to work on WordPress code, it reads these skills and follows the documented procedures rather than guessing.
57+
58+
59+
## Global vs. Project Scope
60+
61+
Skills can be installed in two scopes:
62+
63+
**Global** — installed in your home directory (e.g. `~/.claude/skills/`, `~/.cursor/skills/`).
64+
- Available across **all** your projects automatically.
65+
- Best for individual developers who want WordPress knowledge in every repo.
66+
67+
**Project** — installed inside a repository (e.g. `.claude/skills/`, `.github/skills/`, `.cursor/skills/`).
68+
- Available only within **that specific project**.
69+
- Can be committed to version control so the entire team benefits.
70+
71+
You can use both at the same time. When a skill exists in both scopes, the project-level version is used.
72+
4173
## Quick Start
4274

75+
The fastest way to install a skill is with a single command:
76+
77+
```bash
78+
npx skills add WordPress/agent-skills --skill wp-plugin-development
79+
```
80+
81+
To see all available skills:
82+
83+
```bash
84+
npx skills add WordPress/agent-skills --list
85+
```
86+
87+
To install multiple skills at once:
88+
89+
```bash
90+
npx skills add WordPress/agent-skills --skill wp-plugin-development wp-abilities-api wp-playground
91+
```
92+
93+
#### Choosing a scope
94+
95+
`npx skills add` asks to choose the skill **project-scoped**, selecting the local scope on which the skills are installed in the local project; it can be stored at the repository (e.g. `.claude/skills/`, `.cursor/skills/`) — so the skills can be committed to version control and shared with your team.
96+
97+
Installing **globally** makes the skill available to your user (across **all** your projects). Adding the `-g` / `--global` flag, it will install your skill with global scope:
98+
99+
```bash
100+
npx skills add WordPress/agent-skills --skill wp-plugin-development --global
101+
```
102+
43103
### Install globally for Claude Code
44104

45105
```bash
@@ -104,23 +164,6 @@ node shared/scripts/skillpack-install.mjs --dest=../my-repo --targets=claude,cur
104164

105165
Copy any skill folder from `skills/` into your project's instructions directory for your AI assistant.
106166

107-
## How It Works
108-
109-
Each skill contains:
110-
111-
```
112-
skills/wp-block-development/
113-
├── SKILL.md # Main instructions (when to use, procedure, verification)
114-
├── references/ # Deep-dive docs on specific topics
115-
│ ├── block-json.md
116-
│ ├── deprecations.md
117-
│ └── ...
118-
└── scripts/ # Deterministic helpers (detection, validation)
119-
└── list_blocks.mjs
120-
```
121-
122-
When you ask your AI assistant to work on WordPress code, it reads these skills and follows the documented procedures rather than guessing.
123-
124167
## Compatibility
125168

126169
- **WordPress 6.9+** (PHP 7.2.24+)

0 commit comments

Comments
 (0)