Skip to content

Commit 4b9da5c

Browse files
authored
Merge pull request #395 from hufterkruk/readme
chore: Remove trailing whitespace and fix some typos in README
2 parents 8b06501 + bdec489 commit 4b9da5c

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
[![GoDoc](https://godoc.org/github.com/databus23/helm-diff?status.svg)](https://godoc.org/github.com/databus23/helm-diff)
44
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/databus23/helm-diff/blob/master/LICENSE)
55

6-
This is a Helm plugin giving your a preview of what a `helm upgrade` would change.
6+
This is a Helm plugin giving you a preview of what a `helm upgrade` would change.
77
It basically generates a diff between the latest deployed version of a release
8-
and a `helm upgrade --debug --dry-run`. This can also be used to compare two
8+
and a `helm upgrade --debug --dry-run`. This can also be used to compare two
99
revisions/versions of your helm release.
1010

1111
<a href="https://asciinema.org/a/105326" target="_blank"><img src="https://asciinema.org/a/105326.png" /></a>
@@ -32,10 +32,10 @@ curl -L $TARBALL_URL | tar -C $(helm home)/plugins -xzv
3232
#### Prerequisites
3333
- GoLang `>= 1.17`
3434

35-
Make sure you do not have a verison of `helm-diff` installed. You can remove it by running `helm plugin uninstall diff`
35+
Make sure you do not have a version of `helm-diff` installed. You can remove it by running `helm plugin uninstall diff`
3636

3737
#### Installation Steps
38-
The first step is to download the repository and enter the directory. You can do this via `git clone` or downloaing and extracting the release. If you clone via git, remember to checkout the latest tag for the latest release.
38+
The first step is to download the repository and enter the directory. You can do this via `git clone` or downloading and extracting the release. If you clone via git, remember to checkout the latest tag for the latest release.
3939

4040
Next, depending on which helm version you have, install the plugin into helm.
4141

@@ -57,18 +57,18 @@ The Helm Diff Plugin
5757
5858
* Shows a diff explaining what a helm upgrade would change:
5959
This fetches the currently deployed version of a release
60-
and compares it to a local chart plus values. This can be
60+
and compares it to a local chart plus values. This can be
6161
used visualize what changes a helm upgrade will perform.
6262
6363
* Shows a diff explaining what had changed between two revisions:
6464
This fetches previously deployed versions of a release
65-
and compares them. This can be used visualize what changes
65+
and compares them. This can be used visualize what changes
6666
were made during revision change.
6767
6868
* Shows a diff explaining what a helm rollback would change:
6969
This fetches the currently deployed version of a release
7070
and compares it to the previously deployed version of the release, that you
71-
want to rollback. This can be used visualize what changes a
71+
want to rollback. This can be used visualize what changes a
7272
helm rollback will perform.
7373
7474
Usage:
@@ -117,7 +117,7 @@ Flags:
117117
--version string specify the exact chart version to use. If this is not specified, the latest version is used
118118
119119
Additional help topics:
120-
diff
120+
diff
121121
122122
Use "diff [command] --help" for more information about a command.
123123
```
@@ -198,7 +198,7 @@ Global Flags:
198198
```
199199
$ helm diff release -h
200200
201-
This command compares the manifests details of a different releases created from the same chart
201+
This command compares the manifests details of a different release created from the same chart
202202
203203
It can be used to compare the manifests of
204204
@@ -234,18 +234,18 @@ Global Flags:
234234
```
235235
$ helm diff revision -h
236236
237-
This command compares the manifests details of a named release.
237+
This command compares the manifest details of a named release.
238+
239+
It can be used to compare the manifests of
238240
239-
It can be used to compare the manifests of
240-
241241
- latest REVISION with specified REVISION
242242
$ helm diff revision [flags] RELEASE REVISION1
243-
Example:
243+
Example:
244244
$ helm diff revision my-release 2
245245
246246
- REVISION1 with REVISION2
247247
$ helm diff revision [flags] RELEASE REVISION1 REVISION2
248-
Example:
248+
Example:
249249
$ helm diff revision my-release 2 3
250250
251251
Usage:
@@ -266,7 +266,7 @@ Global Flags:
266266
```
267267
$ helm diff rollback -h
268268
269-
This command compares the latest manifest details of a named release
269+
This command compares the latest manifest details of a named release
270270
with specific revision values to rollback.
271271
272272
It forecasts/visualizes changes, that a helm rollback could perform.

0 commit comments

Comments
 (0)