You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by an...@apache.org on 2013/07/11 22:29:22 UTC

[15/22] git commit: updating plugin spec

updating plugin spec


Project: http://git-wip-us.apache.org/repos/asf/cordova-plugman/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugman/commit/b0fe1f4b
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugman/tree/b0fe1f4b
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugman/diff/b0fe1f4b

Branch: refs/heads/plugman-registry
Commit: b0fe1f4b01826fb0e8df2975caa3c040ed1b3269
Parents: c7a0ff9
Author: Anis Kadri <an...@apache.org>
Authored: Mon Jun 17 16:08:32 2013 -0700
Committer: Anis Kadri <an...@apache.org>
Committed: Thu Jul 11 13:12:38 2013 -0700

----------------------------------------------------------------------
 plugin_spec.md | 38 ++++++++++++++++++++++++++++++++++++--
 1 file changed, 36 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-plugman/blob/b0fe1f4b/plugin_spec.md
----------------------------------------------------------------------
diff --git a/plugin_spec.md b/plugin_spec.md
index 2fbabbf..efe1de4 100644
--- a/plugin_spec.md
+++ b/plugin_spec.md
@@ -72,12 +72,46 @@ If no `<engine>` tags are specified, plugman will attempt to install into the sp
 ## &lt;name&gt; element
 
 A human-readable name for the plugin. The text content of the element contains
-the name of the plugin. An example:
+the name of the plugin. Has to be lower case and cannot contain spaces or special characters. An example:
 
-    <name>Foo</name>
+    <name>foo</name>
 
 This element does not (yet) handle localization.
 
+## &lt;description&gt; element
+
+A human-readable description for the plugin. The text content of the element contains
+the description of the plugin. An example:
+
+    <description>foo plugin description</description>
+
+This element does not (yet) handle localization.
+
+## &lt;author&gt; element
+
+Plugin author name. The text content of the element contains
+the name of the plugin author. An example:
+
+    <author>foo plugin description</author>
+
+## &lt;keywords&gt; element
+
+Plugin keywords. The text content of the element contains comma separated keywords to describe the plugin. An example:
+
+    <keywords>foo,bar</keywords>
+
+## &lt;license&gt; element
+
+Plugin license. The text content of the element contains the plugin license. An example:
+
+    <keywords>foo,bar</keywords>
+
+## &lt;license&gt; element
+
+Plugin license. The text content of the element contains the plugin license. An example:
+
+    <license>Apache</license>
+
 ## &lt;asset&gt; element
 
 One or more elements listing the files or directories to be copied into a