summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTristan Sloughter <t@crashfast.com>2014-10-01 07:18:28 -0500
committerTristan Sloughter <t@crashfast.com>2014-10-01 07:18:28 -0500
commit75e669dc801616271ffee0e6db56a5e0bdfe4fc5 (patch)
treeeaac2efe85446742bac5e88545168730433e0708 /README.md
parentf84c358ad85b9fbf615adc21c8213e03d1b86690 (diff)
update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 7 insertions, 6 deletions
diff --git a/README.md b/README.md
index 86981c1..bbaa063 100644
--- a/README.md
+++ b/README.md
@@ -23,10 +23,11 @@ This is an experimental branch.
| Command | Description |
|----------- |------------ |
| compile | Build project |
+| clean | Remove project apps beam files |
| update | Update package index |
+| upgrade | Fetch latest version of dep |
| 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 |
@@ -76,9 +77,9 @@ Example:
%% Public API
%% ===================================================================
--spec init(rebar_config:config()) -> {ok, rebar_config:config()}.
+-spec init(rebar_state:state()) -> {ok, rebar_state:state()}.
init(State) ->
- State1 = rebar_config:add_provider(State, rebar_provider:create([{name, ?PROVIDER},
+ State1 = rebar_state:add_provider(State, rebar_provider:create([{name, ?PROVIDER},
{provider_impl, ?MODULE},
{bare, false},
{deps, ?DEPS},
@@ -88,10 +89,10 @@ init(State) ->
{opts, []}])),
{ok, State1}.
--spec do(rebar_config:config()) -> {ok, rebar_config:config()}.
-do(Config) ->
+-spec do(rebar_state:state()) -> {ok, rebar_state:state()}.
+do(State) ->
%% Do something
- {ok, Config}.
+ {ok, State}.
```