Formats README.md

This commit is contained in:
Elia el Lazkani 2021-03-20 11:55:21 +01:00
parent c002e8c116
commit ddbe773a80

View file

@ -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. 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 ``` text
$ get-k8s-resources -h $ 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. 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. 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.