From 365626339a2b60bc559e43a498552185622e3148 Mon Sep 17 00:00:00 2001
From: Andrew Williams <andy@tensixtyone.com>
Date: Thu, 7 May 2020 19:55:03 +0100
Subject: [PATCH] Update documentation

---
 README.md                    | 32 ++++++++++++++++++++++++++++++++
 charts/calibre-web/README.md |  7 ++++---
 charts/deluge/README.md      |  7 ++++---
 3 files changed, 40 insertions(+), 6 deletions(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c2c7394
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# Helm Charts
+
+A small set of custom Helm charts to cover some smaller applications not covered by Stable and other repos.
+
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![](https://github.com/nikdoof/helm-charts/workflows/Release%20Charts/badge.svg?branch=master)](https://github.com/nikdoof/helm-charts/actions)
+
+## Usage
+
+[Helm](https://helm.sh) must be installed to use the charts.
+Please refer to Helm's [documentation](https://helm.sh/docs/) to get started.
+
+Once Helm is set up properly, add the repo as follows:
+
+```console
+helm repo add nikdoof https://nikdoof.github.io/helm-charts/
+```
+
+You can then run `helm search nikdoof` to see the charts.
+
+## Charts
+
+See [charts folder](./charts) for a complete list.
+
+* [aaisp-to-mqtt](./charts/aaisp-to-mqtt) - A tool to pull information from [Andrews & Arnold](https://www.aa.net.uk/) CHAOSv2 API and output to MQTT
+* [calibre-web](./charts/calibre-web) - Web app for browsing, reading and downloading eBooks stored in a Calibre database
+* [deluge](./charts/deluge) - Deluge torrent client 
+
+
+## License
+
+[MIT License](./LICENSE)
\ No newline at end of file
diff --git a/charts/calibre-web/README.md b/charts/calibre-web/README.md
index f51660d..9aecb12 100644
--- a/charts/calibre-web/README.md
+++ b/charts/calibre-web/README.md
@@ -5,7 +5,8 @@ This is a helm chart for [calibre-web](https://calibre-web.com/) leveraging the
 ## TL;DR;
 
 ```shell
-$ helm install ./calibre-web
+$ helm repo add nikdoof https://nikdoof.github.io/helm-charts/
+$ helm install calibre-web
 ```
 
 ## Installing the Chart
@@ -13,7 +14,7 @@ $ helm install ./calibre-web
 To install the chart with the release name `my-release`:
 
 ```console
-helm install --name my-release ./calibre-web
+helm install --name my-release calibre-web
 ```
 
 ## Uninstalling the Chart
@@ -101,4 +102,4 @@ If you get `Error: rendered manifests contain a resource that already exists. Un
 
 ---
 
-Read through the [values.yaml](https://github.com/nikdoof/home-k8s-flux/blob/master/charts/calibre-web/values.yaml) file. It has several commented out suggested values.
+Read through the [values.yaml](https://github.com/nikdoof/helm-charts/tree/master/charts/calibre-web/values.yaml) file. It has several commented out suggested values.
diff --git a/charts/deluge/README.md b/charts/deluge/README.md
index 1714501..194b8f8 100644
--- a/charts/deluge/README.md
+++ b/charts/deluge/README.md
@@ -5,7 +5,8 @@ This is a helm chart for [deluge](https://deluge.com/) leveraging the [Linuxserv
 ## TL;DR;
 
 ```shell
-$ helm install ./deluge
+$ helm repo add nikdoof https://nikdoof.github.io/helm-charts/
+$ helm install deluge
 ```
 
 ## Installing the Chart
@@ -13,7 +14,7 @@ $ helm install ./deluge
 To install the chart with the release name `my-release`:
 
 ```console
-helm install --name my-release ./deluge
+helm install --name my-release deluge
 ```
 
 ## Uninstalling the Chart
@@ -105,4 +106,4 @@ If you get `Error: rendered manifests contain a resource that already exists. Un
 
 ---
 
-Read through the [values.yaml](https://github.com/nikdoof/home-k8s-flux/blob/master/charts/deluge/values.yaml) file. It has several commented out suggested values.
+Read through the [values.yaml](https://github.com/nikdoof/helm-charts/tree/master/charts/deluge/values.yaml) file. It has several commented out suggested values.