diff --git a/README.md b/README.md index 6f25cc6..a7474dd 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,12 @@ [![Build Stats](https://buildstats.info/github/chart/splunk/qbec?branch=main)](https://buildstats.info/github/chart/splunk/qbec?branch=main) -Qbec (pronounced like the [Canadian province](https://en.wikipedia.org/wiki/Quebec)) is a CLI tool that -allows you to create Kubernetes objects on multiple Kubernetes clusters or namespaces configured correctly for +Qbec (pronounced like the [Canadian province](https://en.wikipedia.org/wiki/Quebec)) is a CLI tool that +allows you to create Kubernetes objects on multiple Kubernetes clusters or namespaces configured correctly for the target environment in question. -It is based on [jsonnet](https://jsonnet.org) and is similar to other tools in the same space like -[kubecfg](https://github.com/ksonnet/kubecfg) and [ksonnet](https://ksonnet.io/). +It is based on [jsonnet](https://jsonnet.org) and is similar to other tools in the same space like +[kubecfg](https://github.com/ksonnet/kubecfg) and [ksonnet](https://ksonnet.io/). For more info, [read the docs](https://qbec.io/) @@ -25,7 +25,7 @@ Use a prebuilt binary [from the releases page](https://github.com/splunk/qbec/re On MacOS, you can install qbec using homebrew: ``` -$ brew tap splunk/tap +$ brew tap splunk/tap $ brew install qbec ``` @@ -37,3 +37,7 @@ cd qbec make install # installs lint tools etc. make ``` + +### Sign the CLA + +Follow the steps here [cla-assistant](https://github.com/splunk/cla-agreement)