From f8122d9aa1151734d25490ab07d64608a23e0ebf Mon Sep 17 00:00:00 2001
From: Alanna Burke <alanna.burke@amazee.com>
Date: Mon, 28 Mar 2022 18:01:39 -0400
Subject: [PATCH 1/2] Update README.md

---
 README.md | 34 +++++++++++++++++++++++-----------
 1 file changed, 23 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index 9f9aeb1d..3e9a8a7c 100644
--- a/README.md
+++ b/README.md
@@ -4,11 +4,32 @@
 
 This repository contains [Helm](https://helm.sh/) charts related to [Lagoon](https://github.com/amazeeio/lagoon/).
 
+## Table of Contents
+1. Project Description
+2. Usage
+3. Tips & Tricks
+4. Contribution
+
+## Project Description
+[More in-depth paragraph(s) describing the project. What is this project, and what does it do?]
+
 ## Usage
 
-See [here](https://uselagoon.github.io/lagoon-charts/).
+`helm repo add lagoon https://uselagoon.github.io/lagoon-charts/`
+
+See individual chart directories for READMEs and usage instructions.
+
+
+## Tips & Tricks
+
+### Run chart-testing (lint) locally
+
+```
+$ docker run --rm --interactive --detach --network host --name ct "--volume=$(pwd):/workdir" "--workdir=/workdir" --volume=$(pwd)/default.ct.yaml:/etc/ct/ct.yaml quay.io/helmpack/chart-testing:latest cat
+$ docker exec ct ct lint
+```
 
-## Contribute
+## Contribution
 
 Branch/fork and add/edit a chart in the `charts/` directory.
 When you create a PR your change will be automatically linted and tested.
@@ -37,12 +58,3 @@ Please ensure that any new chart:
 The CI runs in a [constrained environment](https://docs.github.com/en/actions/reference/virtual-environments-for-github-hosted-runners#supported-runners-and-hardware-resources) which makes it a good place to test how your chart handles slow-starting pods.
 Ideally pods should never be killed due to failing probes during chart-install, even if they do eventually start and the chart installation succeeds.
 Documentation on probes for pod startup is [here](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes).
-
-## Development tips
-
-### Run chart-testing (lint) locally
-
-```
-$ docker run --rm --interactive --detach --network host --name ct "--volume=$(pwd):/workdir" "--workdir=/workdir" --volume=$(pwd)/default.ct.yaml:/etc/ct/ct.yaml quay.io/helmpack/chart-testing:latest cat
-$ docker exec ct ct lint
-```

From 1cf61f8c3749e5026ce4467cae1f40033e0b68e9 Mon Sep 17 00:00:00 2001
From: Alanna Burke <alanna.burke@amazee.com>
Date: Thu, 31 Mar 2022 18:56:23 -0400
Subject: [PATCH 2/2] Update README.md

Co-authored-by: Toby Bellwood <toby.bellwood@amazee.io>
---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 3e9a8a7c..1912954a 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@ This repository contains [Helm](https://helm.sh/) charts related to [Lagoon](htt
 4. Contribution
 
 ## Project Description
-[More in-depth paragraph(s) describing the project. What is this project, and what does it do?]
+This repository provides the helm charts needed to install the various Lagoon components. It hosts the chart configurations and the chart repository itself (via GitHub pages)
 
 ## Usage