Skip to content

Commit 77ee25f

Browse files
docs: sync readme examples from snippets
1 parent 5bf0a25 commit 77ee25f

9 files changed

Lines changed: 1187 additions & 59 deletions

File tree

.markdown-coderc.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"snippetRoot": "./snippets",
3+
"markdownGlob": "README.md",
4+
"excludeGlob": ["node_modules/**", ".git/**", "dist/**"],
5+
"includeExtensions": [".ts", ".bash", ".sh"]
6+
}

README.md

Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,13 @@ Users should install portable skills from the `skills/` subpath, for example `np
5959

6060
## Install
6161

62-
```bash
62+
```bash snippet=readme/snippet-01.bash
6363
npm install -D @gleanwork/pluginpack
6464
```
6565

6666
## Config
6767

68-
```ts
68+
```ts snippet=readme/snippet-02.ts
6969
import { defineConfig } from "@gleanwork/pluginpack";
7070

7171
export default defineConfig({
@@ -124,21 +124,39 @@ Each target has a smart default component list. By default, `claude`, `cursor`,
124124

125125
Use `components` only when a plugin needs an exact target-specific component set:
126126

127-
```ts
128-
targets: {
129-
gemini: {
130-
outDir: "plugins/gemini",
131-
plugins: {
132-
acme: { from: ["core"], components: ["skills", "commands"] },
127+
```ts snippet=readme/snippet-03.ts
128+
import { defineConfig } from "@gleanwork/pluginpack";
129+
130+
export default defineConfig({
131+
name: "acme-plugins",
132+
version: "0.1.0",
133+
source: {
134+
skills: "skills",
135+
rootPlugin: {
136+
id: "core",
137+
description: "Acme portable skills.",
133138
},
134139
},
135-
claude: {
136-
outDir: "plugins/claude",
137-
plugins: {
138-
acme: { from: ["core"], components: ["skills"] },
140+
metadata: {
141+
description: "Acme agent plugins.",
142+
author: { name: "Acme" },
143+
license: "MIT",
144+
},
145+
targets: {
146+
gemini: {
147+
outDir: "plugins/gemini",
148+
plugins: {
149+
acme: { from: ["core"], components: ["skills", "commands"] },
150+
},
151+
},
152+
claude: {
153+
outDir: "plugins/claude",
154+
plugins: {
155+
acme: { from: ["core"], components: ["skills"] },
156+
},
139157
},
140158
},
141-
}
159+
});
142160
```
143161

144162
## Other Shapes
@@ -206,7 +224,7 @@ For one target, copying files by hand may be enough. `pluginpack` starts to earn
206224

207225
`pluginpack diff` is designed for automation. It builds into a temporary directory, compares generated managed files against an existing plugin repo, and exits non-zero when the plugin repo is stale:
208226

209-
```bash
227+
```bash snippet=readme/snippet-04.bash
210228
pluginpack diff --target cursor --against ../cursor-plugins
211229
pluginpack diff --target claude --against ../claude-plugins
212230
```

mise.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
[tools]
2-
node = "24"
2+
node = "24.15.0"

0 commit comments

Comments
 (0)