Improve docs (#21)

README.md

@@ -1,15 +1,35 @@
 [![Go](https://github.com/fmenezes/codeowners/workflows/Go/badge.svg)](https://github.com/fmenezes/codeowners/actions?query=branch%3Amaster)
 [![Go Report Card](https://goreportcard.com/badge/github.com/fmenezes/codeowners)](https://goreportcard.com/report/github.com/fmenezes/codeowners)
 [![Coverage](https://coveralls.io/repos/github/fmenezes/codeowners/badge.svg?branch=master)](https://coveralls.io/github/fmenezes/codeowners?branch=master)
+[![Godoc](https://godoc.org/github.com/fmenezes/codeowners?status.svg)](https://godoc.org/github.com/fmenezes/codeowners)
 
 # CODEOWNERS
 
-CodeOwners coder provides funcionality to evaluate CODEOWNERS file in Go. Also provices linter CLI.
+CodeOwners coder provides funcionality to evaluate CODEOWNERS file in Go. Also provides linter CLI.
 
 ## Documentation
 
+### Package
+
 To find package documentation follow https://godoc.org/github.com/fmenezes/codeowners
 
+### CLI
+
+#### Installation
+
+Simply run `go get -u github.com/fmenezes/codeowners/cmd/codeowners`
+
+#### Usage
+
+Simply calling `codeowners` will quick off the cli on the current directory.
+
+##### Options
+
+| Option        | Default Value | Description                                                                    |
+| ------------- | ------------- | ------------------------------------------------------------------------------ |
+| d             | .             | Directory: specifies the directory you want to use to lint the CODEOWNERS file |
+| f             |               | Format: specifies the format you want to return lint results                   |
+
 ## Compatibility
 
 :warning: This module is on a v0 mode and it is not ready to be used, once it reaches the v1 we will lock the API.

cmd/linter_test.go → cmd/codeowners/linter_test.go

@@ -16,7 +16,7 @@ func testRun(opt options) (string, error) {
 
 func TestPass(t *testing.T) {
 	opt := options{
-		directory: "../test/data/pass",
+		directory: "../../test/data/pass",
 		format:    "",
 	}
 
@@ -34,7 +34,7 @@ func TestPass(t *testing.T) {
 
 func TestNoOwners(t *testing.T) {
 	opt := options{
-		directory: "../test/data/no_owners",
+		directory: "../../test/data/no_owners",
 		format:    "",
 	}
 
@@ -52,7 +52,7 @@ func TestNoOwners(t *testing.T) {
 
 func TestCustomFormat(t *testing.T) {
 	opt := options{
-		directory: "../test/data/noowners",
+		directory: "../../test/data/noowners",
 		format:    "test",
 	}
 
@@ -69,7 +69,7 @@ func TestCustomFormat(t *testing.T) {
 
 func TestInvalidFormat(t *testing.T) {
 	opt := options{
-		directory: "../test/data/noowners",
+		directory: "../../test/data/noowners",
 		format:    "  {{template \"one\"}}  ",
 	}
 
@@ -79,7 +79,7 @@ func TestInvalidFormat(t *testing.T) {
 	}
 
 	opt = options{
-		directory: "../test/data/noowners",
+		directory: "../../test/data/noowners",
 		format:    "  {{ . ",
 	}
 

cmd/main.go → cmd/codeowners/main.go

@@ -9,8 +9,8 @@ import (
 )
 
 func main() {
-	dir := flag.String("d", ".", "Specifies the directory you want to use to lint the CODEOWNERS file")
-	format := flag.String("f", "", "Specifies the format you want to return lint results")
+	dir := flag.String("d", ".", "Directory: specifies the directory you want to use to lint the CODEOWNERS file")
+	format := flag.String("f", "", "Format: specifies the format you want to return lint results")
 	flag.Parse()
 
 	opt := options{