Update README.md

Author: aumer-amr

README.md

@@ -1,4 +1,41 @@
-# API Generation
+# Gatus Operator
+<sup><sup>Not affiliated with gatus.io</sup></sup>
+
+**State**: Alpha (in development, use at your own risk)
+
+## Install
+1. Install the crds
+```bash
+kubectl apply -f crds/bases/gatus.io_gatuses.yaml
+```  
+2. Install RBAC
+```bash
+kubectl apply -f rbac.yaml
+```
+3. Run container as per usual
+
+## Usage
+Example: resources/test.yaml
+```yaml
+---
+apiVersion: gatus.io/v1alpha1
+kind: Gatus
+metadata:
+  name: gatus-test
+  namespace: observability
+spec:
+  endpoint:
+    enabled: true
+    name: gatus-test
+    url: https://example.com
+    interval: 1m
+    conditions: ["[STATUS] == 200"]
+```
+
+The api is generated from the gatus package as well with some minor tweaks (to make it working).
+Most options you use in your normal gatus configs, you should be able to use like this.
+
+## API Generation
 The operator builds the api and crd based on the Endpoint type struc from Gatus itself, using a very alpha generator which definitely could use a rewrite as it contains many exceptions and other smaller hacks to at least continue my development time on the operator itself.
 The API is generated using the following commands:
 
@@ -8,8 +45,8 @@ The API is generated using the following commands:
 - controller-gen crd:crdVersions=v1 paths=./api/v1alpha1 output:crd:dir=./crd/bases
 ```
 
-## Change in fields
+### Change in fields
 - HttpClient in ClientConfig is ommited (can't deep copy it)
 - ProviderOverride is casted to map[string]json.RawMessage
 - Any time.Duration is casted to string for the CRD (otherwise it will be an int64)
-- Everything is forced to be omitempty so the configmap will only contain the fields that are actually set
+- Everything is forced to be omitempty so the configmap will only contain the fields that are actually set