mirror of
https://github.com/getcompanion-ai/co-mono.git
synced 2026-04-17 06:04:51 +00:00
docs: document video and image fields for package gallery
This commit is contained in:
parent
0aa0b5fdba
commit
1fbafd6cc7
1 changed files with 21 additions and 0 deletions
|
|
@ -93,6 +93,27 @@ Add a `pi` manifest to `package.json` or use conventional directories. Include t
|
||||||
|
|
||||||
Paths are relative to the package root. Arrays support glob patterns and `!exclusions`.
|
Paths are relative to the package root. Arrays support glob patterns and `!exclusions`.
|
||||||
|
|
||||||
|
### Gallery Metadata
|
||||||
|
|
||||||
|
The [package gallery](https://shittycodingagent.ai/packages) displays packages tagged with `pi-package`. Add `video` or `image` fields to show a preview:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"name": "my-package",
|
||||||
|
"keywords": ["pi-package"],
|
||||||
|
"pi": {
|
||||||
|
"extensions": ["./extensions"],
|
||||||
|
"video": "https://example.com/demo.mp4",
|
||||||
|
"image": "https://example.com/screenshot.png"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- **video**: MP4 only. On desktop, autoplays on hover. Clicking opens a fullscreen player.
|
||||||
|
- **image**: PNG, JPEG, GIF, or WebP. Displayed as a static preview.
|
||||||
|
|
||||||
|
If both are set, video takes precedence.
|
||||||
|
|
||||||
## Package Structure
|
## Package Structure
|
||||||
|
|
||||||
### Convention Directories
|
### Convention Directories
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue