From 333ffcb467b7bb00620d807ee0ebf0dd7b26a08f Mon Sep 17 00:00:00 2001 From: Erik Svensson Date: Fri, 24 Nov 2023 20:13:11 +0100 Subject: [PATCH] update readme --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6e15e42..54428b5 100644 --- a/README.md +++ b/README.md @@ -16,11 +16,12 @@ Is meant to be used either stand alone like: ```bash split-yaml -f longfile.yaml -o files ``` -to split longfile.yaml into multiple files, they will be named $(name)-$(kind).yaml and end up in the files directory (in this case). -Or it can be used when piping output into it like this: +to split longfile.yaml into multiple files, they will be named `$(name)-$(kind).yaml` and end up in the `./files/` directory (in this case). + +It can also be used when piping output into it like this: ```bash -kubectl get deploy,svc,configmap,ingress -o yaml | split-yaml -o files - +kubectl get deploy,svc,configmap,ingress -o yaml | split-yaml -o files -f - ``` To split the `kind: List` content into individual files. -Contributing PR's are welcome! If you want to expand it to use real kubernetes objects, I'm open to contributions. \ No newline at end of file +Feel free to reach out with suggestions or issues! \ No newline at end of file