summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTristan Sloughter <t@crashfast.com>2014-09-20 10:05:45 -0500
committerTristan Sloughter <t@crashfast.com>2014-09-20 10:05:45 -0500
commitf0a362c2dcfe65bded4d83a64a360c63b861a54d (patch)
treef4036226738822d75655eea1473ede0332c0d3af
parent1046f4c5d75965dec5e3155194e34540aadeddd0 (diff)
update readme
-rw-r--r--README.md24
1 files changed, 11 insertions, 13 deletions
diff --git a/README.md b/README.md
index c1ad571..86981c1 100644
--- a/README.md
+++ b/README.md
@@ -27,6 +27,8 @@ This is an experimental branch.
| pkgs | List available packages |
| shell | Run shell with project apps in path |
| escriptize | Create escript from project |
+| new | Create new rebar project from templates |
+| do | Higher-order provider to run multiple tasks in sequence |
The following commands are still in the works.
@@ -34,10 +36,8 @@ The following commands are still in the works.
|----------- |------------ |
| release | Build release of project |
| tar | Package release into tarball |
-| new | |
| eunit | |
| ct | |
-| do | |
### Missing
@@ -69,8 +69,6 @@ Example:
-export([init/1,
do/1]).
--include("rebar.hrl").
-
-define(PROVIDER, something).
-define(DEPS, []).
@@ -80,17 +78,17 @@ Example:
-spec init(rebar_config:config()) -> {ok, rebar_config:config()}.
init(State) ->
- State1 = rebar_config:add_provider(State, #provider{name = ?PROVIDER,
- provider_impl = ?MODULE,
- bare = false,
- deps = ?DEPS,
- example = "rebar something",
- short_desc = "",
- desc = "",
- opts = []}),
+ State1 = rebar_config:add_provider(State, rebar_provider:create([{name, ?PROVIDER},
+ {provider_impl, ?MODULE},
+ {bare, false},
+ {deps, ?DEPS},
+ {example, "rebar dummy"},
+ {short_desc, "dummy plugin."},
+ {desc, ""},
+ {opts, []}])),
{ok, State1}.
--spec do(rebar_config:config()) -> {ok, rebar_config:config()} | relx:error().
+-spec do(rebar_config:config()) -> {ok, rebar_config:config()}.
do(Config) ->
%% Do something
{ok, Config}.