update to build release

README.md

@@ -1,26 +1,17 @@
 rebar3_cuttlefish
 =====
 
-A rebar plugin
+This plugin provides cuttlefish and automatically updates the release configuration at runtime to utilize cuttlefish.
 
-Build
------
+Add the plugin to your top level rebar config:
 
-    $ rebar3 compile
+    {plugins, [rebar3_cuttlefish]}.
 
-Use
----
 
-Add the plugin to your rebar config:
+The cuttlefish release and tar providers need
 
-    {plugins, [
-        {rebar3_cuttlefish, {git, "git@github.com:tsloughter/rebar3_cuttlefish.git", {branch, "master"}}}
-    ]}.
+    $ rebar3 cuttlefish release
 
-Then just call your plugin directly in an existing application:
+The plugin provider will tell relx to create the dirs `share/schema` in the release, copy the cuttlefish escript to `bin/` and discover all schema files in the project apps and their dependencies.
 
-
-    $ rebar3 cuttlefish
-    ===> Fetching rebar3_cuttlefish
-    ===> Compiling rebar3_cuttlefish
-    ===> Running cuttlefish schema generator
+Since cuttlefish uses sort order of the schema files by their name you may want to prepend a number to the schema file name, like `01-eleveldb.schema`. While the plugin will automatically copy all schema files for you it will first check if there is already an overlay entry for each schema file. So if in `overlay` there is an entry `{template, "schema/eleveldb.schema", "01-eleveldb.schema"}` it will not make another copy.