Update readme/getting started

criticalstack · Nov 13, 2020 · 413a4b8 · 413a4b8
1 parent 04e587c
commit 413a4b8
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/.github/workflows/chart_release.yaml b/.github/workflows/chart_release.yaml
@@ -4,7 +4,7 @@ on:
   push:
     # Sequence of patterns matched against refs/tags
     tags:
-      - 'chart:v*' # Push events to matching v*, i.e. v1.0, v20.15.10
+      - 'chart/v*' # Push events to matching v*, i.e. v1.0, v20.15.10
 
 jobs:
   release:

diff --git a/README.md b/README.md
@@ -6,6 +6,8 @@ The premier, officially supported mechanism for deploying a kubernetes applicati
 
 This repo is the home of `StackApps` (and `StackValues`, `StackReleases`, ...) CRDs, controllers, and webhooks.
 
+Check out [the docs](https://criticalstack.github.io/stackapps/).
+
 Uses [kubebuilder](https://github.com/kubernetes-sigs/kubebuilder).
 
 ## Install

diff --git a/docs/src/getting-started.md b/docs/src/getting-started.md
@@ -1,3 +1,12 @@
 # Getting Started
 
-### Stay tuned for getting started documentation.
+## Install
+
+Using [Helm](https://helm.sh/docs/intro/install/):
+
+```shell
+$ helm dependency update .
+$ helm install stackapps ./chart
+```
+
+## Stay tuned for more getting started documentation.