a couple documentation updates before the next release (#28)

Boeing · Jun 1, 2023 · bb82c6e · bb82c6e
1 parent 78a11b1
commit bb82c6e
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 5 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -9,8 +9,8 @@ We welcome contributions! We want to make contributing to this project as easy a
 ## We Develop with Github
 We use github to host code, to track issues and feature requests, as well as accept pull requests.
 
-## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
-Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
+## We Use [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow), So All Code Changes Happen Through Pull Requests
+Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow)). We actively welcome your pull requests:
 
 1. Fork the repo and create your branch from `main`.
 2. If you've added code that should be tested, add tests.

diff --git a/README.md b/README.md
@@ -46,9 +46,8 @@ If you have a go environment on your desktop you can use [go install](https://go
 go install github.com/Boeing/config-file-validator/cmd/validator
 ```
 
-
-### Executables
-Executables are available for Linux and Windows (macOS coming soon!). Navigate to the [releases](https://github.com/Boeing/config-file-validator/releases) page to download the latest version. Once the executable has been downloaded it needs to be installed by moving the downloaded file to a location on your OS PATH.
+### Binaries
+Binary downloads are available for Linux, Windows, and MacOS. Navigate to the [releases](https://github.com/Boeing/config-file-validator/releases) page to download the latest version. Once the binary has been downloaded it needs to be installed by moving the downloaded file to a location on your OS PATH.
 
 ## Using
 ```
@@ -78,6 +77,13 @@ validator -search-path /path/to/search -exclude-dirs=/path/to/search/tests
 
 ![Exclude Dirs Run](./img/exclude_dirs.png)
 
+#### JSON Output
+Output the results in JSON
+
+```
+validator -search-path /path/to/search -reporter json
+```
+
 #### Container Run
 ```
 docker run -it --rm -v /path/to/config/file/location:/test -search-path=/test