@@ -46,7 +46,8 @@ make undeploy
4646``` 
4747
4848## Contributing  
49- // TODO(user): Add detailed information on how you would like others to contribute to this project
49+ 
50+ Refer to [ CONTRIBUTING.md] ( ./CONTRIBUTING.md )  for more information.
5051
5152### How it works  
5253This project aims to follow the Kubernetes [ Operator pattern] ( https://kubernetes.io/docs/concepts/extend-kubernetes/operator/ ) 
@@ -55,19 +56,13 @@ It uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controlle
5556which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster 
5657
5758### Test It Out  
58- 1 .  Install the CRDs into the cluster:
59- 
60- ``` sh 
61- make install
62- ``` 
63- 
64- 2 .  Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
6559
60+ Install the CRDs and the operator-controller into a new [ KIND cluster] ( https://kind.sigs.k8s.io/ ) :
6661``` sh 
6762make run
6863``` 
69- 
70- ** NOTE: **  You can  also run this in one step by running:  ` make install run ` 
64+ This will build a local container image of the operator-controller, create a new KIND cluster and then deploy onto that cluster. 
65+ This will  also deploy the catalogd, rukpak and cert-manager dependencies. 
7166
7267### Modifying the API definitions  
7368If you are editing the API definitions, generate the manifests such as CRs or CRDs using:
@@ -76,13 +71,13 @@ If you are editing the API definitions, generate the manifests such as CRs or CR
7671make manifests
7772``` 
7873
79- ** NOTE:**  Run ` make -- help `  for more information on all potential ` make `  targets
74+ ** NOTE:**  Run ` make help `  for more information on all potential ` make `  targets
8075
8176More information can be found via the [ Kubebuilder Documentation] ( https://book.kubebuilder.io/introduction.html ) 
8277
8378## License  
8479
85- Copyright 2022.
80+ Copyright 2022-2023 .
8681
8782Licensed under the Apache License, Version 2.0 (the "License");
8883you may not use this file except in compliance with the License.
0 commit comments