1 files changed, 26 insertions, 0 deletions
diff --git a/priv/templates/plugin_README.md b/priv/templates/plugin_README.md
new file mode 100644
index 0000000..7f9ba84
--- /dev/null
+++ b/priv/templates/plugin_README.md
@@ -0,0 +1,26 @@
+{{name}}
+=====
+
+{{desc}}
+
+Build
+-----
+
+    $ rebar3 compile
+
+Use
+---
+
+Add the plugin to your rebar config:
+
+    {plugins, [
+        { {{name}}, ".*", {git, "git@host:user/{{name}}.git", {tag, "0.1.0"}}}
+    ]}.
+
+Then just call your plugin directly in an existing application:
+
+
+    $ rebar3 {{name}}
+    ===> Fetching {{name}}
+    ===> Compiling {{name}}
+    <Plugin Output>