Improve readme

Author: jake klein

README.md

@@ -1,6 +1,6 @@
 # concourse-flake-detector
 
-A tool to find flakey jobs in a Concourse pipeline. Flakey in this context is when a build fails when it has otherwise passed with the same set of inputs. This is currently restricted to only checking changes to git input.
+A tool to find flakey jobs in a Concourse pipeline. Flakey in this context is when a build fails when it has otherwise passed with the same set of inputs. This is currently restricted to only checking changes to git resources.
 
 In order to build the flake-detect checkout the repo and run `cd cmd/flake-detector && go build .`
 ## Usage
@@ -13,36 +13,33 @@ In order to build the flake-detect checkout the repo and run `cd cmd/flake-detec
 
 `-count <number of builds to scan>` Optional- Only scan the last x amount of builds. Currently max's and defaults at 100.
 
-`-bearer <bearer authentication token>` Optional- Needed if your pipeline is not public. To obtain a bearer token go to `<ci-url>/api/v1/teams/<team>/auth/token`or run the `flake-detector` without the flag configured and it will prompt you with the URL to go to to obtained a token.
+`-bearer <bearer authentication token>` Optional- Needed if your pipeline is not public. To obtain a bearer token go to `<ci-url>/api/v1/teams/<team>/auth/token`or run the `flake-detector` without the flag configured and it will prompt you with the URL to go to obtain a token.
 
 `-debug <boolean>` Optional- Configure true if you want debug information about what endpoints are being hit.
 
 
 
- `./flake-detector  -pipeline <pipeline-name> -url <ci-url>`. If your pipeline is configured under a team add the `-team <my-team-name>` flag.
-
-
  ##### Examples
 
 `./flake-detector -team main -pipeline main -url https://ci.concourse.ci`
 
 ```
-+------------------------+--------+-------+
-|          NAME          | BUILDS | FLAKE |
-+------------------------+--------+-------+
-| fly                    |     74 |     0 |
-| atc                    |     74 |     9 |
-| baggageclaim           |     74 |     0 |
-| blackbox               |     74 |     2 |
-| bosh-testflight        |     74 |     1 |
-| bin-testflight         |     74 |     0 |
-| bosh-deploy            |     74 |     2 |
-| bin-smoke              |     74 |     1 |
-| bin-docker             |     74 |     1 |
-| shipit                 |      8 |     0 |
-| virtualbox-box         |     13 |     2 |
-| virtualbox-testflight  |     11 |     1 |
-| release-virtualbox-box |      7 |     2 |
-| topgun                 |     74 |     7 |
-+------------------------+--------+-------+
++------------------------+--------+--------+
+|          NAME          | BUILDS | FLAKES |
++------------------------+--------+--------+
+| fly                    |     74 |      0 |
+| atc                    |     74 |      9 |
+| baggageclaim           |     74 |      0 |
+| blackbox               |     74 |      2 |
+| bosh-testflight        |     74 |      1 |
+| bin-testflight         |     74 |      0 |
+| bosh-deploy            |     74 |      2 |
+| bin-smoke              |     74 |      1 |
+| bin-docker             |     74 |      1 |
+| shipit                 |      8 |      0 |
+| virtualbox-box         |     13 |      2 |
+| virtualbox-testflight  |     11 |      1 |
+| release-virtualbox-box |      7 |      2 |
+| topgun                 |     74 |      7 |
++------------------------+--------+--------+
 ```

cmd/flake-detector/flake-detector.go

@@ -107,7 +107,7 @@ func main() {
 
 	fmt.Println(results)
 	table := tablewriter.NewWriter(os.Stdout)
-	table.SetHeader([]string{"Name", "builds", "flake"})
+	table.SetHeader([]string{"Name", "builds", "flakes"})
 
 	for _, v := range results {
 		table.Append(v)

integration_tests/flake-detector_test.go

@@ -61,7 +61,7 @@ var _ = Describe("flake-detector", func() {
 			_, logBuffer := runFlakeDetector(0, params...)
 
 			Expect(logBuffer).To(gbytes.Say("Pipeline: %s", pipelineName))
-			Expect(string(logBuffer.Contents())).To(ContainSubstring("%s |      2 |     0 |", jobName))
+			Expect(string(logBuffer.Contents())).To(ContainSubstring("%s |      2 |      0 |", jobName))
 
 		})
 	})
@@ -99,7 +99,7 @@ var _ = Describe("flake-detector", func() {
 			_, logBuffer := runFlakeDetector(0, params...)
 
 			Expect(logBuffer).To(gbytes.Say("Pipeline: %s", pipelineName))
-			Expect(string(logBuffer.Contents())).To(ContainSubstring("%s |      2 |     1 |", jobName))
+			Expect(string(logBuffer.Contents())).To(ContainSubstring("%s |      2 |      1 |", jobName))
 
 		})
 
@@ -141,7 +141,7 @@ var _ = Describe("flake-detector", func() {
 			_, logBuffer := runFlakeDetector(0, params...)
 
 			Expect(logBuffer).To(gbytes.Say("Pipeline: %s", pipelineName))
-			Expect(string(logBuffer.Contents())).To(ContainSubstring("%s |      2 |     0 |", jobName))
+			Expect(string(logBuffer.Contents())).To(ContainSubstring("%s |      2 |      0 |", jobName))
 
 		})
 	})