From af861e632b2715c8eb602c4329fbb88b2b67f54f Mon Sep 17 00:00:00 2001 From: Euen Date: Mon, 28 Dec 2015 15:49:39 -0300 Subject: [PATCH] [Close #3] update README.md --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2917816..3fd47f0 100644 --- a/README.md +++ b/README.md @@ -27,4 +27,26 @@ DEP_PLUGINS = elvis_mk ## Help Run `make help` in order to check what targets are available for -`elvis.mk`. \ No newline at end of file +`elvis.mk`. + +## Example + +For example you can run `make elvis`: + +```make +Loading files... +Loading src/your_module.erl +Applying rules... +# src/your_module.erl [FAIL] + - operator_spaces + - Missing space after "," on line 27 +Loading files... +Loading Makefile +Applying rules... +# Makefile [OK] +Loading files... +Loading elvis.config +Applying rules... +# elvis.config [OK] +make: *** [elvis] Error 1 +``` \ No newline at end of file