summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 16 insertions, 12 deletions
diff --git a/README.md b/README.md
index 075b841..e2bb9ac 100644
--- a/README.md
+++ b/README.md
@@ -11,21 +11,13 @@ embed directly in a project. Where possible, rebar uses standard Erlang/OTP
conventions for project structures, thus minimizing the amount of build
configuration work. rebar also provides dependency management, enabling
application writers to easily re-use common libraries from a variety of
-locations (git, hg, etc).
+locations ([hex.pm](http://hex.pm), git, hg, and so on).
-3.0 Alpha-6
+3.0 Beta-1
====
[DOCUMENTATION](http://www.rebar3.org/v3.0/docs)
-This is a preliminary branch, considered to be alpha, and still
-very unstable. Use at your own risk, but please do report bugs
-and issues encountered and we'll try to resolve problems as
-soon as possible.
-
-Compatibility with rebar 2.0 has been broken, and features removed to
-limit scope.
-
### Commands
| Command | Description |
@@ -35,6 +27,7 @@ limit scope.
| clean | Remove project apps beam files |
| cover | Generate coverage info from data compiled by `eunit --cover` or `ct --cover` |
| ct | Run Common Test suites |
+| deps | Lists dependencies currently in use |
| do | Higher-order provider to run multiple tasks in sequence |
| dialyzer | Run the Dialyzer analyzer on the project |
| edoc | Generate documentation using edoc |
@@ -55,15 +48,26 @@ limit scope.
| version | Print current version of Erlang/OTP and rebar |
| xref | Run cross reference analysis on the project |
+A more complete list can be found on the [docs page](http://www.rebar3.org/v3.0/docs/commands)
+
### Changes
+#### Since Rebar 2.x
+
* Fetches and builds deps if missing when running any command that relies on them
* Automatically recognizes `apps` and `lib` directory structure
-* Relx for releases
+* Relx for releases and relups
+* deterministic builds and conflict resolution
+* New plugin handling mechanism
+* New hook mechanism
+* Support for packages
+* A ton more
### Gone
* Reltool integeration
+* Quickcheck integration (moved to [a plugin](http://www.rebar3.org/v3.0/docs/using-available-plugins#quickcheck))
+* C code compiling (moved to [a plugin](http://www.rebar3.org/v3.0/docs/using-available-plugins#port-compiler) or hooks)
### Providers
@@ -144,7 +148,6 @@ $ ./rebar3 escriptize
$ _build/default/bin/rebar3
```
-
Contributing to rebar
=====================
@@ -174,3 +177,4 @@ General rebar community resources and links:
- #rebar on [irc.freenode.net](http://freenode.net/)
- [wiki](https://github.com/rebar/rebar/wiki)
- [issues](https://github.com/rebar/rebar/issues)
+- [Documentation](http://www.rebar3.org/v3.0/docs)