Skip to content

Commit

Permalink
improve wording
Browse files Browse the repository at this point in the history
  • Loading branch information
itaysk committed Aug 5, 2019
1 parent e5bc775 commit b5de69f
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# kubectl-neat

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

## Demo

Expand Down
13 changes: 8 additions & 5 deletions krew-template.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,20 @@ metadata:
name: neat
spec:
version: "v0.1.1"
shortDescription: Clean up Kubernetes yaml and json output to make it readable.
shortDescription: Remove clutter from Kubernetes manifests to make them more readable.
homepage: https://github.com/itaysk/kubectl-neat
description: |
If you try to `kubectl get` resources you have just created,
they be unreadably verbose. `kubectl-neat` cleans up that redundant information.
Can be used as a `kubectl get` wrapper, or by piping into it.
For example `kubectl neat pod mypod -o yaml` or
`kubectl get pod mypod -o yaml | kubectl neat`.
Examples:
`$ kubectl neat pod mypod -o yaml`
`$ kubectl get pod mypod -o yaml | kubectl neat`
caveats: |
This plugin depends on the following binaries -
`jq`, `yq` and `sponge` (from `moreutils`), which should be installed by the user
This plugin depends on the following utilities which should be installed manually:
- `jq`
- `yq`
- `sponge` (from `moreutils`)
platforms:
- selector:
matchLabels:
Expand Down

0 comments on commit b5de69f

Please sign in to comment.