first run at readme updates

CONTRIBUTING.md

@@ -14,6 +14,16 @@ Fairwinds is built on top of [controller-runtime](https://github.com/kubernetes-
 
 We label issues with the ["good first issue" tag](https://github.com/reactiveops/fairwinds/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) if we believe they'll be a good starting point for new contributors. If you're interested in working on an issue, please start a conversation on that issue, and we can help answer any questions as they come up.
 
+## Running Tests
+
+The following commands are all required to pass as part of Fairwinds testing:
+
+```
+go list ./ | grep -v vendor | xargs golint -set_exit_status
+go list ./ | grep -v vendor | xargs go vet
+go test ./pkg/... -v -coverprofile cover.out
+```
+
 ## Creating a New Issue
 
 If you've encountered an issue that is not already reported, please create an issue that contains the following:

README.md

@@ -1,3 +1,4 @@
+<<<<<<< HEAD
 ## Build locally
 This package is best built using [packr](https://github.com/gobuffalo/packr), which provides
 a thin wrapper around the go compiler in order to include static HTML/CSS/JS assets.
@@ -6,24 +7,55 @@ git clone https://github.com/reactiveops/fairwinds $GOPATH/src/github.com/reacti
 go get -u github.com/gobuffalo/packr/v2/packr2
 packr2 build -a -o fairwinds *.go
 ./fairwinds -h
-```
+=======
+<p align="center">
+  <img src="/public/images/logo.png" alt="Fairwinds Logo" />
+</p>
 
-## Run on-cluster
+Fairwinds aims to keep your cluster sailing smoothly. It runs a variety of checks to ensure that Kubernetes deployments are configured using best practices that will avoid potential problems in the future. The project includes two primary parts:
 
-On GKE, you'll need to run the following command first:
-```
-kubectl create clusterrolebinding cluster-admin-binding \
-  --clusterrole cluster-admin \
-  --user $(gcloud config get-value account)
-```
+- A dashboard to display the results of these validations on your existing deployments
+- A webhook that can prevent poorly configured deployments from reaching your cluster
+
+## Dashboard
+
+The Fairwinds Dashboard provides an overview of your current deployments in a cluster along with their validation scores. An overall score is provided for a cluster on a 0 - 100 scale. Results for each validation are grouped by namespace and deployment.
+
+### Deploying
+
+To deploy Fairwinds with kubectl:
 
-Then apply the config:
 ```
 kubectl apply -f deploy/all.yaml
+>>>>>>> first run at readme updates
 ```
 
+Fairwinds can also be deployed with Helm:
 
-## Options
+```
+helm upgrade --install fairwinds deploy/helm/fairwinds/ --namespace fairwinds --recreate-pods
+```
+
+### Viewing the Dashboard
+
+Once the dashboard is deployed, it can be viewed by using kubectl port-forward:
+```
+kubectl port-forward --namespace fairwinds svc/fairwinds-fairwinds-dashboard 8080:80 &
+open http://localhost:8080
+```
+
+### Using a Binary Release
+
+If you'd prefer to run Fairwinds locally, binary releases are available on the [releases page](https://github.com/reactiveops/fairwinds/releases). With a Fairwinds binary, the
+
+## Webhook
+
+The Fairwinds Webhook can run the same checks as the dashboard, but can be deployed and configured separately. When running, the webhook will validate any new or updated deployments in the cluster, and reject any that fail a check with an `error` severity.
+
+Unfortunately we have not found a way to disply warnings as part of `kubectl` output unless we are rejecting a deployment altogether. That means that any checks with a severity of `warning` will still pass webhook validation, and the only evidence of that warning will either be in the Fairwinds dashboard or the Fairwinds webhook logs.
+
+
+## CLI Options
 
 * `config`: Specify a location for the Fairwinds config
 * `dashboard`: Runs the webserver for Fairwinds dashboard.
@@ -31,21 +63,4 @@ kubectl apply -f deploy/all.yaml
 * `webhook`: Runs the webhook webserver.
 * `webhook-port`: Port for the webhook webserver (default 9876)
 * `disable-webhook-config-installer`: disable the installer in the webhook server, so it won't install webhook configuration resources during bootstrapping
-* `kubeconfig`: Paths to a kubeconfig. Only required if out-of-cluster.
-* `master`: The address of the Kubernetes API server. Overrides any value in kubeconfig. Only required if out-of-cluster.
-
-## Helm Deploy Option
-
-* Create release with Helm:
-```
-helm upgrade --install fairwinds deploy/helm/fairwinds/ --namespace fairwinds --recreate-pods
-kubectl port-forward --namespace fairwinds svc/fairwinds-fairwinds-dashboard 8080:80 &
-open http://localhost:8080
-```
-
-## Run tests
-```
-go list ./... | grep -v vendor | xargs golint -set_exit_status
-go list ./... | grep -v vendor | xargs go vet
-go test ./pkg/... -v -coverprofile cover.out
-```
+* `kubeconfig`: Paths to a kubeconfig. Only required if out-of-cluster.