From e89ef4c1ecf5cc44ea0a1bc47028a5fc7b8c5390 Mon Sep 17 00:00:00 2001 From: Nikolai Rodionov Date: Thu, 1 Jun 2023 23:24:05 +0200 Subject: [PATCH] Better Readme --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index deaf8f8..ba2c11d 100644 --- a/README.md +++ b/README.md @@ -3,16 +3,27 @@ kubers is a super simple tool that reveals k8s secrets using kubectl and yq +The tool requires `yq` and `kubectl` + Usage: kubers [-V | --version] [-h | --help] [-n | --namespace ] [-c =] [] Examples: If you want to reveal all entries in the current k8s namespace + + ``` $ kubers - + ``` + If you want to reveal only one entry from the secret in the current namepspace + + ``` $ kubers + ``` If you want to reveal a secret from another namespace + + ``` $ kubers -n + ```