chore: complete the README (#38)

Co-authored-by: Tim Jacomb <[email protected]>
timja · Jul 22, 2022 · afce9f0 · afce9f0
1 parent 4bf7f80
commit afce9f0
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -7,10 +7,11 @@ GitHub apps are used for authentication to limit the required permissions.
 
 ## Getting started
 
-First you will need to create a GitHub app. Add the permissions required for the commands you are using.
-Add a webhook to the app pointing at your endpoint, the path for the webhook receiver is `/api/github/webhooks`.
+First you will need to create a GitHub app. Add the permissions required for the commands you are using (see next section), and tick "Subscribe to events" > "Issue comment"
 
-This app is multiple organization aware and doesn't need any additional configuration to run in multiple organizations.
+Add a webhook to the app pointing at your endpoint, the path for the webhook receiver is `<your-app-endpoint>/api/github/webhooks`.
+
+This app is multiple organization aware and doesn't need any additional configuration to run in multiple organizations, you just need to install it on them.
 
 _Note: You can't interact across organizations, like requesting reviews from teams in different organizations or transferring issues, this is a GitHub limitation._
 
@@ -22,6 +23,17 @@ Run `smee --path /api/github/webhooks` and point your webhook to the smee url th
 
 The application runs on port 3000 by default, this can be customized with the `PORT` environment variable.
 
+### Chart deployment
+
+You can deploy this application to Kubernetes with the helm chart included in this repo:
+
+```
+helm repo add github-comment-ops https://timja.github.io/github-comment-ops
+helm install github-comment-ops github-comment-ops/github-comment-ops
+```
+
+See more in the [chart README](charts/github-comment-ops/README.md)
+
 ### Required environment variables
 
 - `GITHUB_APP_ID`

diff --git a/charts/github-comment-ops/README.md b/charts/github-comment-ops/README.md
@@ -4,6 +4,15 @@
 
 A tool for managing GitHub issues and pull requests via comment-ops. It uses GitHub webhooks to scale across repositories without needing to add a GitHub action to each of them.
 
+## Chart deployment
+
+You can deploy this application to Kubernetes with the helm chart included in this repo:
+
+```
+helm repo add github-comment-ops https://timja.github.io/github-comment-ops
+helm install github-comment-ops github-comment-ops/github-comment-ops
+```
+
 ## Example
 
 ```yaml

diff --git a/charts/github-comment-ops/README.md.gotmpl b/charts/github-comment-ops/README.md.gotmpl
@@ -13,6 +13,16 @@
 
 {{ template "chart.requirementsSection" . }}
 
+## Chart deployment
+
+You can deploy this application to Kubernetes with the helm chart included in this repo:
+
+```
+helm repo add github-comment-ops https://timja.github.io/github-comment-ops
+helm install github-comment-ops github-comment-ops/github-comment-ops
+```
+
+
 ## Example
 
 ```yaml