From e5083a384ea66c12594a88a1c8659068646ad78b Mon Sep 17 00:00:00 2001
From: mgechev <mgechev@gmail.com>
Date: Sun, 4 Feb 2018 12:19:24 -0800
Subject: [PATCH] Update readme

---
 README.md | 23 +++++++++++++++++++++--
 1 file changed, 21 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 7e8ba58..d430ed4 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,30 @@
 # revive
 
-Linter for Go.
+Fast, configurable, extensible, and beautiful linter for Go.
 
 <p align="center">
   <img src="./assets/logo.png" alt="" width="200">
 </p>
 
-# License
+## Usage
+
+Revive is **configurable** linter which you can fit your needs.
+
+### Command Line Flags
+
+Revive accepts only three command line parameters:
+
+* `config` - path to config file in TOML format.
+* `exclude` - pattern for files/directories/packages to be excluded for linting. You can specify the files you want to exclude for linting either as package name (i.e. `github.com/mgechev/revive`), list them as individual files (i.e. `file.go file2.go`), directories (i.e. `./foo/...`), or any combination of the three.
+* `formatter` - formatter to be used for the output. The currently available formatters are:
+  * `default` - will output the warnings the same way that `golint` does.
+  * `json` - outputs the warnings in JSON format.
+  * `cli` - formats the warnings in a table.
+
+### Configuration
+
+Revive can be configured with a TOML file
+
+## License
 
 MIT