Add an example for the description variable to the meta file

[github/shaarli/Shaarli.git] / doc / md / Plugin-System.md

diff --git a/doc/md/Plugin-System.md b/doc/md/Plugin-System.md
index 7a5ba23d2b3888f68280ce3d86af865e6d825e8f..d5b16e2d0d2a200129e709b80932ee3a3ceb7b4e 100644 (file)
--- 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.