From 296e75217c7c2e63529bdab7f744beee9328d221 Mon Sep 17 00:00:00 2001 From: sharepointoscar Date: Mon, 20 Apr 2020 09:21:06 -0700 Subject: [PATCH] updated verbiage and usage on readme --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index fa5c9d4..9b2bdcb 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,37 @@ ![cocktail](logo.png) -# Cocktail - Combine two passions and this is what comes out of it. +# Kname + Combine several passions and this is what comes out of it. -I am a big fan of mixology. One day I decided I hated coming up with names for my [Kubernetes](https://kubernetes.io/) clusters as I test stuff, and so Cocktail was born. +I am a big fan of mixology, fitness andd the great outdoors. One day I decided I hated coming up with names for my [Kubernetes](https://kubernetes.io/) clusters as I test stuff, and so Kname was born. # What is this? -Cocktail is a simple CLI that you can use to spit out a random cocktail name which you can use to name whatever, but I use it for Kubernetes cluster names as I have a difficult time coming up with them. +Kname is a simple CLI that you can use to spit out a random name based on the theme you choose. You can use to name whatever, but I use it for Kubernetes cluster names as I have a difficult time coming up with them. # Installing -Like any other `go` packaage. +Like any other `go` package. ```bash -go get github.com/sharepointoscar/cocktail +go get github.com/sharepointoscar/kname ``` ## Using Jenkins X CLI I use Jenkins X on GKE and EKS (soon AKS), but here is how I quickly create my cluster passing the random name. ```bash -jx create cluster gke --skip-installation -n $(cocktail generate-name) +jx create cluster gke --skip-installation -n $(kname generate-name --theme cocktails) ``` ## GCloud CLI usage If you are using the `gcloud` CLI, you can just execute the following (add whatever other flags you want) ```bash -gcloud container clusters create $(cocktail generate-name) +gcloud container clusters create $(kname generate-name --theme yoga) ``` ## eksctl CLI usage ```bash -eksctl create cluster --name $(cocktail generate-name) +eksctl create cluster --name $(kname generate-name --theme national-parks) ```