Update README.md

keisku · Sep 10, 2024 · c172492 · c172492
1 parent 10feacc
commit c172492
Showing 1 changed file with 11 additions and 57 deletions.
diff --git a/README.md b/README.md
@@ -2,71 +2,25 @@
 
 [![.github/workflows/test.yaml](https://github.com/keisku/kubectl-explore/actions/workflows/test.yaml/badge.svg)](https://github.com/keisku/kubectl-explore/actions/workflows/test.yaml)
 
-Fuzzy-find the field to explain from all API resources.
-
 ![demo](./demo.gif)
 
-### See also
-
-- [kubectl explore, a better kubectl explain](https://keisku.medium.com/kubectl-explore-a-better-kubectl-explain-46a939fafe3a)
-- [kubectl explain にあいまい検索(fuzzy-find)機能を追加したプラグイン kubectl-explore を作った](https://zenn.dev/kskumgk63/articles/d52be6c4a31bbb)
-
-## Motivation
+## What’s lacking in the original `kubectl-explain`?
 
-- `kubectl explain` needs knowing in advance the resources name/fields.
-- `kubectl explain` needs typing the accurate path to the resource name/field, which is a tedious and typo-prone.
-
-## Usage
-
-```
-Fuzzy-find the field to explain from all API resources.
+- `kubectl explain` requires knowing in advance the resource name/fields.
+- `kubectl explain` requires typing the accurate path to the resource name/field, which is a tedious and typo-prone.
 
-Usage:
-  kubectl explore [resource|regex] [flags]
+## Example Usage
 
-Examples:
-
-# Fuzzy-find the field to explain from all API resources.
+```bash
+# Fuzzy-find a resource, then a field to explain
 kubectl explore
 
-# Fuzzy-find the field to explain from pod.
+# Fuzzy-find from all fields of a specific resource.
 kubectl explore pod
+kubectl explore sts
 
-# Fuzzy-find the field to explain from fields matching the regex.
-kubectl explore pod.*node
-kubectl explore spec.*containers
-kubectl explore lifecycle
+# Fuzzy-find from fields that a given regex matches.
 kubectl explore sts.*Account
-
-# Fuzzy-find the field to explain from all API resources in the selected cluster.
-kubectl explore --context=onecontext
-
-
-Flags:
-      --api-version string             Get different explanations for particular API version (API group/version)
-      --as string                      Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
-      --as-group stringArray           Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
-      --as-uid string                  UID to impersonate for the operation.
-      --cache-dir string               Default cache directory (default "/root/.kube/cache")
-      --certificate-authority string   Path to a cert file for the certificate authority
-      --client-certificate string      Path to a client certificate file for TLS
-      --client-key string              Path to a client key file for TLS
-      --cluster string                 The name of the kubeconfig cluster to use
-      --context string                 The name of the kubeconfig context to use
-      --disable-compression            If true, opt-out of response compression for all requests to the server
-      --disable-print-path             Disable printing the path to explain
-  -h, --help                           help for kubectl
-      --insecure-skip-tls-verify       If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
-      --kubeconfig string              Path to the kubeconfig file to use for CLI requests.
-      --match-server-version           Require server version to match client version
-  -n, --namespace string               If present, the namespace scope for this CLI request
-      --password string                Password for basic authentication to the API server
-      --request-timeout string         The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
-  -s, --server string                  The address and port of the Kubernetes API server
-      --tls-server-name string         Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
-      --token string                   Bearer token for authentication to the API server
-      --user string                    The name of the kubeconfig user to use
-      --username string                Username for basic authentication to the API server
 ```
 
 ## Installation
@@ -93,7 +47,7 @@ nix-env -iA nixpkgs.kubectl-explore
 
 Download the binary from [GitHub Releases](https://github.com/keisku/kubectl-explore/releases) and drop it in your `$PATH`.
 
-```shell
+```bash
 # Other available architectures are linux_arm64, darwin_amd64, darwin_arm64, windows_amd64.
 export ARCH=linux_amd64
 # Check the latest version, https://github.com/keisku/kubectl-explore/releases/latest
@@ -103,7 +57,7 @@ wget -O- "https://github.com/keisku/kubectl-explore/releases/download/${VERSION}
 
 From source.
 
-```shell
+```bash
 go install github.com/keisku/kubectl-explore@latest
 sudo mv $GOPATH/bin/kubectl-explore /usr/local/bin
 ```