From 58d1587aad651d659c58c267ebb49ee04c3dbb3f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ota=CC=81vio=20Fernandes?= Date: Wed, 9 Jun 2021 11:36:47 +0200 Subject: [PATCH] Initial "usage" documentation. --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 73545964e..658110384 100644 --- a/README.md +++ b/README.md @@ -4,4 +4,26 @@ An operator to install and configure [Shipwright](https://shipwright.io) on Kube ## Contributing -See [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to build, test, and submit contributions to the operator. +See [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to build, test, and submit +contributions to the operator. + +## Usage + +To deploy and manage instances of [Shipwright Build-Controller][build-controller], make sure this +operator is up-and-running, and then create the following: + +```yml +--- +apiVersion: operator.shipwright.io/v1alpha1 +kind: ShipwrightBuild +metadata: + name: shipwright-operator +spec: + namespace: default +``` + +It will deploy the Build-Controller in `default` namespace. When `.spec.namespace` is not informed, +it will use the `shipwright-build` namespace instead, this namespace needs to be created before the +actual deployment takes place. + +[build-controller]: https://github.com/shipwright-io/build