Skip to content

Commit b5de69f

Browse files
committed
improve wording
1 parent e5bc775 commit b5de69f

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

Readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# kubectl-neat
22

3-
Clean up Kubernetes yaml and json output to make it readable.
3+
Remove clutter from Kubernetes manifests to make them more readable.
44

55
## Demo
66

krew-template.yaml

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,20 @@ metadata:
44
name: neat
55
spec:
66
version: "v0.1.1"
7-
shortDescription: Clean up Kubernetes yaml and json output to make it readable.
7+
shortDescription: Remove clutter from Kubernetes manifests to make them more readable.
88
homepage: https://github.com/itaysk/kubectl-neat
99
description: |
1010
If you try to `kubectl get` resources you have just created,
1111
they be unreadably verbose. `kubectl-neat` cleans up that redundant information.
1212
Can be used as a `kubectl get` wrapper, or by piping into it.
13-
For example `kubectl neat pod mypod -o yaml` or
14-
`kubectl get pod mypod -o yaml | kubectl neat`.
13+
Examples:
14+
`$ kubectl neat pod mypod -o yaml`
15+
`$ kubectl get pod mypod -o yaml | kubectl neat`
1516
caveats: |
16-
This plugin depends on the following binaries -
17-
`jq`, `yq` and `sponge` (from `moreutils`), which should be installed by the user
17+
This plugin depends on the following utilities which should be installed manually:
18+
- `jq`
19+
- `yq`
20+
- `sponge` (from `moreutils`)
1821
platforms:
1922
- selector:
2023
matchLabels:

0 commit comments

Comments
 (0)