Refresh README tone and concision

Author: integrii

README.md

@@ -1,45 +1,23 @@
-# ssh-check
+# Ssh Check
+
 Check ssh connectivity to nodes within a cluster
 
-This check requires two environment variables in the kube spec used to deploy it.  An ssh key, and the user.
+## What it is
+This repository builds the container image used by Kuberhealthy to run the ssh-check check.
 
-**Example yaml**
+## Image
+- `docker.io/kuberhealthy/ssh-check`
+- Tags: short git SHA for `main` pushes and `vX.Y.Z` for releases.
 
-```yaml
----
-apiVersion: kuberhealthy.github.io/v2
-kind: KuberhealthyCheck
-metadata:
-  name: ssh-check
-  namespace: kuberhealthy
-spec:
-  runInterval: 5m
-  timeout: 2m
-  extraAnnotations:
-    comcast.com/testAnnotation: test.annotation
-  extraLabels:
-    testLabel: testLabel
-  podSpec:
-    containers:
-      - name: ssh-check
-        image: rjacks161/ssh-check:v3.0.0
-        imagePullPolicy: IfNotPresent
-        env:
-          - name: SSH_PRIVATE_KEY
-            value: "CHANGE_ME"
-          - name: SSH_USERNAME
-            value: "CHANGEME"
-          - name: SSH_EXCLUDE_LIST
-            value: "CHANGEME1 CHANGEME2"
-        resources:
-          requests:
-            cpu: 10m
-            memory: 50Mi
-```
+## Quick start
+- Apply the example manifest: `kubectl apply -f ssh-check.yaml`
+- Edit the manifest to set any required inputs for your environment.
 
-#### How-to
+## Build locally
+- `docker build -f ./Dockerfile -t kuberhealthy/ssh-check:dev .`
 
-Apply a `.yaml` file similar to the one shown above with `kubectl apply -f`
+## Contributing
+Issues and PRs are welcome. Please keep changes focused and add a short README update when behavior changes.
 
-#### SSH Exclude List
-The exclude list is a space delimited list of node names that the user would like to exclude from the ssh check.
+## License
+See `LICENSE`.