aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJuan Facorro <[email protected]>2014-11-06 17:30:37 -0300
committerJuan Facorro <[email protected]>2014-11-06 17:58:45 -0300
commitc9eb9023e06a169aa2107124def882a1496d9357 (patch)
tree16072ecc5efdeed5849590e8ed790fa809370577
parent92626f1548c1dea677594c48040066ac2bb6f550 (diff)
downloaderlang.mk-c9eb9023e06a169aa2107124def882a1496d9357.tar.gz
erlang.mk-c9eb9023e06a169aa2107124def882a1496d9357.tar.bz2
erlang.mk-c9eb9023e06a169aa2107124def882a1496d9357.zip
[inaka/elvis#96] Elvis plugin, updated README.
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index 31f718b..bcb5042 100644
--- a/README.md
+++ b/README.md
@@ -331,6 +331,21 @@ EDoc options can be specified in Erlang format by defining
the `EDOC_OPTS` variable. For more information please see
`erl -man edoc`.
+Elvis plugin
+------------
+
+This plugin is available by default. It adds the following
+target:
+
+`elvis` runs Elvis style checker for this application.
+
+The `ELVIS_CONFIG` variable specifies the location of the
+configuration file which holds the rules to be applied.
+If there's no `elvis.config` file the default one will be
+downloaded. When the `ELVIS` variable points to a non-existing
+file then the `elvis` executable will be downloaded as well.
+Any other option should go in the `ELVIS_OPTS` variable.
+
ErlyDTL plugin
--------------