litruv/Plugin-Directory
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document thumbnail field in README

Browse Source
This commit is contained in:
Litruv
2026-04-17 03:42:23 +10:00
parent b78670c871
commit 74bcea4a15
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -19,12 +19,20 @@ Example: `plugins/litruv-example-plugin.json`
"author": "litruv", "author": "litruv",
"repository": "http://synbox.ruv.wtf:8418/litruv/Plugin-Example.git", "repository": "http://synbox.ruv.wtf:8418/litruv/Plugin-Example.git",
"homepage": "http://synbox.ruv.wtf:8418/litruv/Plugin-Example", "homepage": "http://synbox.ruv.wtf:8418/litruv/Plugin-Example",
"thumbnail": "http://synbox.ruv.wtf:8418/litruv/Plugin-Example/raw/branch/main/thumbnail.png",
"tags": ["example"] "tags": ["example"]
} }
``` ```
**Required fields:** `id`, `name`, `version`, `description`, `author`, `repository` **Required fields:** `id`, `name`, `version`, `description`, `author`, `repository`
**Optional fields:** `homepage`, `thumbnail`, `tags`
**Thumbnail requirements:**
- PNG, JPG, or GIF format
- Max 512x512 pixels
- Max 2MB file size
**Important:** **Important:**
- Filename must start with your username: `{username}-` - Filename must start with your username: `{username}-`
- Plugin `id` must match filename (without .json) - Plugin `id` must match filename (without .json)