Browse Source

update README

pull/3/head
Tristan Sloughter 10 years ago
parent
commit
75e669dc80
1 changed files with 7 additions and 6 deletions
  1. +7
    -6
      README.md

+ 7
- 6
README.md View File

@ -23,10 +23,11 @@ This is an experimental branch.
| Command | Description | | Command | Description |
|----------- |------------ | |----------- |------------ |
| compile | Build project | | compile | Build project |
| clean | Remove project apps beam files |
| update | Update package index | | update | Update package index |
| upgrade | Fetch latest version of dep |
| 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 |
| new | Create new rebar project from templates | | new | Create new rebar project from templates |
| do | Higher-order provider to run multiple tasks in sequence | | do | Higher-order provider to run multiple tasks in sequence |
@ -76,9 +77,9 @@ Example:
%% Public API %% Public API
%% =================================================================== %% ===================================================================
-spec init(rebar_config:config()) -> {ok, rebar_config:config()}.
-spec init(rebar_state:state()) -> {ok, rebar_state:state()}.
init(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}, {provider_impl, ?MODULE},
{bare, false}, {bare, false},
{deps, ?DEPS}, {deps, ?DEPS},
@ -88,10 +89,10 @@ init(State) ->
{opts, []}])), {opts, []}])),
{ok, State1}. {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 %% Do something
{ok, Config}.
{ok, State}.
``` ```

Loading…
Cancel
Save