Finish gendiff

Author: alexvitayu

README.md

@@ -1,12 +1,47 @@
-# Gendiff
+# go-project-244
 
-### Hexlet tests and linter status:
+## Description
+This cli application compares two json or yml files and shows the difference in stylish, plain and json formats
+
+## Hexlet tests and linter status:
 [![Actions Status](https://github.com/alexvitayu/go-project-244/actions/workflows/hexlet-check.yml/badge.svg)](https://github.com/alexvitayu/go-project-244/actions)
 
-### SonarQube Standard badge:
+## SonarQube Standard badge:
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=alexvitayu_go-project-244&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=alexvitayu_go-project-244)
 
-### Example of app execution - follow the link:
+## Build and setup
+```ch
+git clone https://github.com/alexvitayu/go-project-244.git
+```
+```ch
+cd go-project-244
+``` 
+```ch
+make build  
+```
+## Run linter
+```ch
+make lint
+```
+## Run tests
 ```ch
-https://asciinema.org/a/sXebIOdYUQdNi131mai8DUjFG
+make test
 ```
+## Install
+### for make install make sure that you have GOBIN set up in your PATH.
+### To discover this just run 'echo $PATH'
+```ch
+make install
+```
+## Help
+```ch
+gendiff -h --help
+```
+## Run the application from the terminal
+```ch
+gendiff
+```
+## Example of app execution - follow the link:
+```ch
+https://asciinema.org/a/iQ2yWhvlLSVuqlCvIJR5FzYoD
+```

cmd/gendiff/main.go

@@ -20,7 +20,10 @@ func main() {
 				Name:    "format",
 				Aliases: []string{"f"},
 				Value:   "stylish",
-				Usage:   "output format"},
+				Usage: `output formats: 
+				-f=stylish
+				-f=plain
+				-f=json`},
 		},
 		Action: func(ctx context.Context, cmd *cli.Command) error {
 			var path1 string