update README instructions

jdockerty · Nov 7, 2022 · e2d20fe · e2d20fe
1 parent 695e97e
commit e2d20fe
Showing 1 changed file with 35 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -2,10 +2,44 @@
 
 A `kubectl` plugin to display the pods and containers which have recently been `OOMKilled`.
 
-## Quick Start
+## Installation 
 
+Via [`krew`](https://krew.sigs.k8s.io/)
 ```
 kubectl krew install oomlie
+```
+
+## Usage
+
+Running the command will display the pods that have recently been `OOMKilled` in your current namespace.
+This also shows the specific container which was killed too, helpful in the case of multi-container pods.
+
+
+```
 kubectl oomlie
+
+POD                         CONTAINER        TERMINATION TIME
+my-app-5bcbcdf97-722jp      infoapp          2022-11-04 10:51:48 +0000 GMT
+my-app-5bcbcdf97-k52lg      infoapp          2022-11-04 10:51:48 +0000 GMT
+my-app-5bcbcdf97-v9ff6      infoapp          2022-11-04 10:51:48 +0000 GMT
+```
+
+You can specify another namespace, as you would with other `kubectl` commands.
+
+```
+kubectl oomlie -n oomkilled
+
+POD                         CONTAINER        TERMINATION TIME
+my-app-5bcbcdf97-722jp      infoapp          2022-11-04 10:51:48 +0000 GMT
+my-app-5bcbcdf97-k52lg      infoapp          2022-11-04 10:51:48 +0000 GMT
+my-app-5bcbcdf97-v9ff6      infoapp          2022-11-04 10:51:48 +0000 GMT
 ```
 
+```
+kubectl oomlie --no-headers
+
+my-app-5bcbcdf97-722jp      infoapp          2022-11-04 10:51:48 +0000 GMT
+my-app-5bcbcdf97-k52lg      infoapp          2022-11-04 10:51:48 +0000 GMT
+my-app-5bcbcdf97-v9ff6      infoapp          2022-11-04 10:51:48 +0000 GMT
+
+```