summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHeinz N. Gies <heinz@licenser.net>2015-11-04 18:26:28 +0100
committerHeinz N. Gies <heinz@licenser.net>2015-11-04 18:26:28 +0100
commit91c47db27a3c63fc04940c7c72433062dbadf042 (patch)
treed724d69c1bfe45e5977c9904094f764ee721ab0b /README.md
parent42695b42b171075b0b349a1e73688dbc19106dc1 (diff)
Add 'configuration' section to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index 69fd4f6..112fa2b 100644
--- a/README.md
+++ b/README.md
@@ -53,6 +53,14 @@ locations ([hex.pm](http://hex.pm), git, hg, and so on).
A more complete list can be found on the [docs page](http://www.rebar3.org/v3.0/docs/commands)
+
+### Configuration
+
+Rebar3 uses the following environment variables to adjust behaviour:
+
+* `REBAR_COLOR` - set to `low` or `high` changes the color of the output to be more or less intense
+* `TERM` - used to detect if logs should be plain text or term colored, uses termcap to determin capabilities. If set to `dumb` colors are supressed.
+
### Changes
#### Since Rebar 2.x