summaryrefslogtreecommitdiff
path: root/priv/templates/plugin_README.md.dtl
diff options
context:
space:
mode:
Diffstat (limited to 'priv/templates/plugin_README.md.dtl')
-rw-r--r--priv/templates/plugin_README.md.dtl15
1 files changed, 14 insertions, 1 deletions
diff --git a/priv/templates/plugin_README.md.dtl b/priv/templates/plugin_README.md.dtl
index 19990f5..c784324 100644
--- a/priv/templates/plugin_README.md.dtl
+++ b/priv/templates/plugin_README.md.dtl
@@ -1,7 +1,7 @@
{{appid}}
=====
-Rebar3 plugin
+{{desc}}
Build
-----
@@ -11,4 +11,17 @@ Build
Use
---
+Add the plugin to your rebar config:
+
+ {plugins, [
+ { {{appid}}, ".*", {git, "git@host:user/{{appid}}.git", {tag, "0.1.0"}}}
+ ]}.
+
+Then just call your plugin directly in an existing application:
+
+
$ rebar3 {{appid}}
+ ===> Fetching {{appid}}
+ Cloning into '.tmp_dir539136867963'...
+ ===> Compiling {{appid}}
+ <Plugin Output>