Browse Source

update readme

pull/3/head
Tristan Sloughter 10 years ago
parent
commit
f0a362c2dc
1 changed files with 11 additions and 13 deletions
  1. +11
    -13
      README.md

+ 11
- 13
README.md View File

@ -27,6 +27,8 @@ This is an experimental branch.
| pkgs | List available packages | | pkgs | List available packages |
| shell | Run shell with project apps in path | | shell | Run shell with project apps in path |
| escriptize | Create escript from project | | 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. 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 | | release | Build release of project |
| tar | Package release into tarball | | tar | Package release into tarball |
| new | |
| eunit | | | eunit | |
| ct | | | ct | |
| do | |
### Missing ### Missing
@ -69,8 +69,6 @@ Example:
-export([init/1, -export([init/1,
do/1]). do/1]).
-include("rebar.hrl").
-define(PROVIDER, something). -define(PROVIDER, something).
-define(DEPS, []). -define(DEPS, []).
@ -80,17 +78,17 @@ Example:
-spec init(rebar_config:config()) -> {ok, rebar_config:config()}. -spec init(rebar_config:config()) -> {ok, rebar_config:config()}.
init(State) -> 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}. {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(Config) ->
%% Do something %% Do something
{ok, Config}. {ok, Config}.

Loading…
Cancel
Save