aboutsummaryrefslogtreecommitdiff
path: root/SPEC.md
diff options
context:
space:
mode:
authorAdam <adamdharrison@gmail.com>2023-01-11 22:21:51 -0500
committerGitHub <noreply@github.com>2023-01-11 22:21:51 -0500
commit7fcdc2f9353ef9abe26fe8a6b7bbd936bc4a4c47 (patch)
treee6242bdaa57019c440aaba674f99d42d89cde362 /SPEC.md
parent0f9fb0343f983418051a88ef630c267e6954f3bb (diff)
downloadlite-xl-plugin-manager-7fcdc2f9353ef9abe26fe8a6b7bbd936bc4a4c47.tar.gz
lite-xl-plugin-manager-7fcdc2f9353ef9abe26fe8a6b7bbd936bc4a4c47.zip
Update SPEC.md
Diffstat (limited to 'SPEC.md')
-rw-r--r--SPEC.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/SPEC.md b/SPEC.md
index b1c8351..1f9744a 100644
--- a/SPEC.md
+++ b/SPEC.md
@@ -39,10 +39,13 @@ The vast majority of plugins are `singleton` plugins.
### Metadata
* `id`: The semantic id of the plugin, a string only containing `[a-z0-9\-_]`.
+* `type`: An optional string that specifies the plugin type. Valid values are `"plugin"`
+ and `"library"`. Defaults to `"plugin"`.
* `name`: The optional name of the plugin.
* `version`: The plugin's semantic version. A string that can contains `[0-9\.]`.
* `description`: An english-language description of the plugin.
-* `mod_version`: The mod_version this plugin is compatible with. A string that can contains `[0-9\.]`.
+* `mod_version`: The mod_version this plugin is compatible with.
+ A string that can contains `[0-9\.]`. If `type` is `library`, this field is optional.
* `provides`: An optional array of strings that are a shorthand of functionality
this plugin provides. Can be used as a dependency.
* `dependencies`: Optionally a hash of dependencies required, or optional