From 4f628bf30b7d9f8727257983d5455102aa7ca774 Mon Sep 17 00:00:00 2001 From: Zachary Yedidia Date: Wed, 12 Feb 2020 00:22:32 -0500 Subject: [PATCH] Remove incorrect plugin documentation --- runtime/help/plugins.md | 30 +----------------------------- 1 file changed, 1 insertion(+), 29 deletions(-) diff --git a/runtime/help/plugins.md b/runtime/help/plugins.md index 8c8b3a50..dd76f8c6 100644 --- a/runtime/help/plugins.md +++ b/runtime/help/plugins.md @@ -11,7 +11,7 @@ from the go plugin, which has the following file structure: ``` ~/.config/micro/plug/go-plugin/ go.lua - info.json + repo.json help/ go-plugin.md ``` @@ -35,34 +35,6 @@ is unlikely for a plugin to need to add plugin files at runtime or syntax header files. No directory structure is enforced but keeping runtime files in their own directories is good practice. -# Info file - -The `info.json` for the Go plugin is the following: - -``` -{ - "name": "go", - "description": "Go formatting and tool support", - "website": "https://github.com/micro-editor/go-plugin", - "install": "https://github.com/micro-editor/go-plugin", - "version": "1.0.0", - "require": [ - "micro >= 2.0.0" - ] -} -``` - -All fields are simply interpreted as strings, so the version does not -need to be a semantic version, and the dependencies are also only -meant to be parsed by humans. The name should be an identifier, and -the website should point to a valid website. The install field should -provide info about installing the plugin, or point to a website that -provides information. - -Note that the name of the plugin is defined by the name field in -the `info.json` and not by the installation path. Some functions micro -exposes to plugins require passing the name of the plugin. - ## Lua callbacks Plugins use Lua but also have access to many functions both from micro