add usage in readme

Signed-off-by: zufardhiyaulhaq <[email protected]>

README.md

@@ -1,10 +1,10 @@
 # ngrok-operator
 
-ngrok-operator for managing ngrok lifecycle
+Ngrok operator provide developer easy access to private Kubernetes cluster for testing purpose via ngrok. Automate the creation of ngrok tunnel via CRD!
 
 ![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) [![made with Go](https://img.shields.io/badge/made%20with-Go-brightgreen)](http://golang.org) [![Github master branch build](https://img.shields.io/github/workflow/status/zufardhiyaulhaq/ngrok-operator/Master)](https://github.com/zufardhiyaulhaq/ngrok-operator/actions/workflows/master.yml) [![GitHub issues](https://img.shields.io/github/issues/zufardhiyaulhaq/ngrok-operator)](https://github.com/zufardhiyaulhaq/ngrok-operator/issues) [![GitHub pull requests](https://img.shields.io/github/issues-pr/zufardhiyaulhaq/ngrok-operator)](https://github.com/zufardhiyaulhaq/ngrok-operator/pulls)
 
-## Installing the Chart
+## Installing
 
 To install the chart with the release name `my-release`:
 
@@ -13,6 +13,28 @@ helm repo add zufardhiyaulhaq https://charts.zufardhiyaulhaq.com/
 helm install my-release zufardhiyaulhaq/ngrok-operator --values values.yaml
 ```
 
+## Usage
+1. Apply some example
+```console
+kubectl apply -f examples/nginx
+kubectl apply -f examples/helloworld/namespace.yaml
+kubectl apply -f examples/helloworld/
+```
+2. Check ngrok object
+```console
+kubectl get ngrok --all-namespaces
+NAMESPACE    NAME               STATUS    URL
+default      nginx-ngrok        created   https://9496e56ed0bc.ngrok.io
+default      nginx-ngrok-full   created   https://ngrok.zufardhiyaulhaq.com
+helloworld   helloworld-ngrok   created   https://d00ba8cb0b95.ngrok.io
+```
+3. access the URL
+```console
+https://d5150f7c3588.ngrok.io
+https://ngrok.zufardhiyaulhaq.com
+https://fa03f71fbe18.ngrok.io/hello
+```
+
 ## Values
 
 | Key | Type | Default | Description |

charts/ngrok-operator/Chart.yaml

@@ -1,7 +1,7 @@
 ---
 apiVersion: v2
 name: ngrok-operator
-description: ngrok-operator for managing ngrok lifecycle
+description: Ngrok operator provide developer easy access to private Kubernetes cluster for testing purpose via ngrok. Automate the creation of ngrok tunnel via CRD!
 version: 1.0.0
 appVersion: 1.0.0
 type: application

charts/ngrok-operator/README.md

@@ -1,10 +1,10 @@
 # ngrok-operator
 
-ngrok-operator for managing ngrok lifecycle
+Ngrok operator provide developer easy access to private Kubernetes cluster for testing purpose via ngrok. Automate the creation of ngrok tunnel via CRD!
 
 ![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) [![made with Go](https://img.shields.io/badge/made%20with-Go-brightgreen)](http://golang.org) [![Github master branch build](https://img.shields.io/github/workflow/status/zufardhiyaulhaq/ngrok-operator/Master)](https://github.com/zufardhiyaulhaq/ngrok-operator/actions/workflows/master.yml) [![GitHub issues](https://img.shields.io/github/issues/zufardhiyaulhaq/ngrok-operator)](https://github.com/zufardhiyaulhaq/ngrok-operator/issues) [![GitHub pull requests](https://img.shields.io/github/issues-pr/zufardhiyaulhaq/ngrok-operator)](https://github.com/zufardhiyaulhaq/ngrok-operator/pulls)
 
-## Installing the Chart
+## Installing
 
 To install the chart with the release name `my-release`:
 
@@ -13,6 +13,28 @@ helm repo add zufardhiyaulhaq https://charts.zufardhiyaulhaq.com/
 helm install my-release zufardhiyaulhaq/ngrok-operator --values values.yaml
 ```
 
+## Usage
+1. Apply some example
+```console
+kubectl apply -f examples/nginx
+kubectl apply -f examples/helloworld/namespace.yaml
+kubectl apply -f examples/helloworld/
+```
+2. Check ngrok object
+```console
+kubectl get ngrok --all-namespaces
+NAMESPACE    NAME               STATUS    URL
+default      nginx-ngrok        created   https://9496e56ed0bc.ngrok.io
+default      nginx-ngrok-full   created   https://ngrok.zufardhiyaulhaq.com
+helloworld   helloworld-ngrok   created   https://d00ba8cb0b95.ngrok.io
+```
+3. access the URL
+```console
+https://d5150f7c3588.ngrok.io
+https://ngrok.zufardhiyaulhaq.com
+https://fa03f71fbe18.ngrok.io/hello
+```
+
 ## Values
 
 | Key | Type | Default | Description |

charts/ngrok-operator/README.md.gotmpl

@@ -3,7 +3,7 @@
 
 {{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}[![made with Go](https://img.shields.io/badge/made%20with-Go-brightgreen)](http://golang.org) [![Github master branch build](https://img.shields.io/github/workflow/status/zufardhiyaulhaq/ngrok-operator/Master)](https://github.com/zufardhiyaulhaq/ngrok-operator/actions/workflows/master.yml) [![GitHub issues](https://img.shields.io/github/issues/zufardhiyaulhaq/ngrok-operator)](https://github.com/zufardhiyaulhaq/ngrok-operator/issues) [![GitHub pull requests](https://img.shields.io/github/issues-pr/zufardhiyaulhaq/ngrok-operator)](https://github.com/zufardhiyaulhaq/ngrok-operator/pulls)
 
-## Installing the Chart
+## Installing
 
 To install the chart with the release name `my-release`:
 
@@ -12,6 +12,28 @@ helm repo add zufardhiyaulhaq https://charts.zufardhiyaulhaq.com/
 helm install my-release zufardhiyaulhaq/ngrok-operator --values values.yaml
 ```
 
+## Usage
+1. Apply some example
+```console
+kubectl apply -f examples/nginx
+kubectl apply -f examples/helloworld/namespace.yaml
+kubectl apply -f examples/helloworld/
+```
+2. Check ngrok object
+```console
+kubectl get ngrok --all-namespaces
+NAMESPACE    NAME               STATUS    URL
+default      nginx-ngrok        created   https://9496e56ed0bc.ngrok.io
+default      nginx-ngrok-full   created   https://ngrok.zufardhiyaulhaq.com
+helloworld   helloworld-ngrok   created   https://d00ba8cb0b95.ngrok.io
+```
+3. access the URL
+```console
+https://d5150f7c3588.ngrok.io
+https://ngrok.zufardhiyaulhaq.com
+https://fa03f71fbe18.ngrok.io/hello
+```
+
 {{ template "chart.requirementsSection" . }}
 
 {{ template "chart.valuesSection" . }}

go.mod

@@ -3,6 +3,7 @@ module github.com/zufardhiyaulhaq/ngrok-operator
 go 1.16
 
 require (
+	github.com/norwoodj/helm-docs v1.6.0 // indirect
 	github.com/onsi/ginkgo v1.16.4
 	github.com/onsi/gomega v1.13.0
 	k8s.io/api v0.21.2