From: flow.gunso <flow.gunso@gmail.com>
Date: Fri, 15 May 2020 20:47:19 +0000 (+0200)
Subject: Add an example for the description variable to the meta file
X-Git-Tag: v0.12.0-beta~9^2
X-Git-Url: https://git.immae.eu/?a=commitdiff_plain;h=refs%2Fpull%2F1461%2Fhead;hp=8f6202deb0cbf58dd18bf0523c81fd24851e3b6c;p=github%2Fshaarli%2FShaarli.git

Add an example for the description variable to the meta file
---

diff --git a/doc/md/Plugin-System.md b/doc/md/Plugin-System.md
index 7a5ba23d..d5b16e2d 100644
--- a/doc/md/Plugin-System.md
+++ b/doc/md/Plugin-System.md
@@ -40,6 +40,8 @@ This function can be used to create initial data, load default settings, etc. Bu
 
 The plugin system also looks for a `description` variable in the <plugin_name>.meta file, to be displayed in the plugin administration page.
 
+    description="The plugin does this and that."
+
 ### Understanding hooks
 
 A plugin is a set of functions. Each function will be triggered by the plugin system at certain point in Shaarli execution.