From 44741b76bc5248022e32dd54b114fb541746af4d Mon Sep 17 00:00:00 2001
From: Andrew Williams <andy@tensixtyone.com>
Date: Sun, 9 Jan 2022 10:46:25 +0000
Subject: [PATCH] Update Documentation

---
 README.md | 41 ++++++++++++++++++++++++++++++++++++-----
 1 file changed, 36 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 36b3d5a..225944c 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,11 @@ Ohayo Dash is a Kubernetes driven start page and dashboard. All configuration is
 
 This is inspired by [Hajimari](https://github.com/toboshii/hajimari) and [SUI](https://github.com/jeroenpardon/sui) projects.
 
-## Ingresses
+## Configuration
+
+All configuration is handled with `ConfigMap` and `Ingress` objects within Kubernetes.
+
+### Ingresses
 
 All namespaces as processed by default, only Ingress objects with `ohayodash.github.io/enabled` annotation are then displayed.
 
@@ -14,7 +18,7 @@ Annotations can be used to customize the display of the Ingress objects:
 * `ohayodash.github.io/url` - Target URL of the service, defaults to `https://<ingress host>`
 * `ohayodash.github.io/show_url` - Shows the URL under the link, defaults to `false`
 
-## Bookmarks
+### Bookmarks
 
 Bookmark are stored in `ConfigMap` resources, which are identified by the `ohayodash.github.io/bookmarks` annotation.
 
@@ -24,7 +28,7 @@ Values are pulled from the `bookmarks` key in the config map, which consists of
 * `url` - the target URL.
 * `group` - the name the link is to be grouped under.
 
-```
+```yaml
 apiVersion: v1
 kind: ConfigMap
 metadata:
@@ -39,7 +43,7 @@ data:
       group: Github
 ```
 
-## Providers
+### Providers
 
 Providers are stored in `ConfigMap` resources, which are identified by the `ohayodash.github.io/providers` annotation.
 
@@ -50,7 +54,9 @@ Values are pulled from the `providers` key in the config map, which consists of
 * `search` - suffix to add to search on the service, this will combine the URL, Search value and the text to search for into a URL.
 * `prefix` - prefix to use on the URL bar on Ohayodash.
 
-```
+*Note*: If no Providers ConfigMaps are found then a [default](ohayodash/data/providers.yaml) list is used.
+
+```yaml
 apiVersion: v1
 kind: ConfigMap
 metadata:
@@ -65,3 +71,28 @@ data:
       search: search/all/
       prefix: /a
 ```
+
+### Combining ConfigMaps
+
+ConfigMaps can be combined to allow for easier management:
+
+```yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: ohayodash-config
+  namespace: web
+  annotations:
+    ohayodash.github.io/bookmarks: 'true'
+    ohayodash.github.io/providers: 'true'
+data:
+  bookmarks: |
+    - name: Renovate Dashboard
+      url: "https://app.renovatebot.com/dashboard#github/nikdoof/flux-gitops"
+      group: Github
+  providers: |
+    - name: Allmusic
+      url: https://www.allmusic.com/
+      search: search/all/
+      prefix: /a
+```
\ No newline at end of file