refactor: finish moving ssh-* scripts to own installers

[webi-installers/.git] / k9s / README.md

diff --git a/k9s/README.md b/k9s/README.md
index b11050d315fb6809402aed3296221239ad6ab427..dff84a17a2c02cdb617d65ac2c6f5ed89c43971d 100644 (file)
--- a/k9s/README.md
+++ b/k9s/README.md
@@ -5,25 +5,28 @@ tagline: |
   K9s provides a terminal UI to interact with your Kubernetes clusters
 ---
 
-### Updating `k9s`
-
-`webi k9s@stable`
-
-Use the `@beta` tag for pre-releases.
+To update or switch versions, run `webi k9s@stable` (or `@v0.24`, `@beta`, etc).
 
 ## Cheat Sheet
 
-> `k9s` aim is to make it easier to navigate, observe and manage your applications in the wild. K9s continually watches Kubernetes for changes and offers subsequent commands to interact with your observed resources.
+The information in this section is a copy of the preflight requirements and
+common command line arguments from k9s (https://github.com/derailed/k9s).
+
+> `k9s` aim is to make it easier to navigate, observe and manage your
+> applications in the wild. K9s continually watches Kubernetes for changes and
+> offers subsequent commands to interact with your observed resources.
 
 ### Preflight check
 
-K9s uses 256 colors terminal mode. On `Nix system make sure TERM is set accordingly.
+K9s uses 256 colors terminal mode. On `Nix system make sure TERM is set
+accordingly.
 
 ```bash
 export TERM=xterm-256color
 ```
 
 To run k9s:
+
 ```bash
 k9s
 ```
@@ -31,26 +34,31 @@ k9s
 ### Command line arguments
 
 List all available CLI options
+
 ```bash
 k9s help
 ```
 
 To get info about K9s runtime (logs, configs, etc..)
+
 ```bash
 k9s info
 ```
 
 To run K9s in a given namespace
+
 ```bash
 k9s -n mycoolns
 ```
 
 Start K9s in an existing KubeConfig context
+
 ```bash
 k9s --context coolCtx
 ```
 
 Start K9s in readonly mode - with all cluster modification commands disabled
+
 ```bash
 k9s --readonly
-```
\ No newline at end of file
+```