diff --git a/README.md b/README.md index d170fca..c48278c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ The `get_k8s_resources` script is a small script that will return a list of all instances of a certain kubernetes type `JSON` formatted. -# Usage +## Usage ``` text $ get-k8s-resources -h @@ -24,10 +24,10 @@ The `get_k8s_resources` script is a small script that will return a list of all ``` -# Requirements +## Requirements The requirements can be found in the [requirements.txt](requirements.txt) file in this repository. -# Configuration +## Configuration By default, this tool will try to find your kubeconfig in the default paths where [kubectl](https://kubernetes.io/docs/reference/kubectl/overview/) looks for. It will also try to take assumptions on which `context` it should be using if there are multiple contexts in the same configuration. Generally, it should work as shown in the help menu.