From 559b5a8f80816ec83c880a814cbe344934ee7aa4 Mon Sep 17 00:00:00 2001
From: Andrew Williams <andy@tensixtyone.com>
Date: Sun, 9 Jan 2022 10:42:02 +0000
Subject: [PATCH] Update Documentation

---
 README.md                    | 64 +++++++++++++++++++++++++++++++++++-
 charts/ohayodash/values.yaml | 21 ++++++++++++
 2 files changed, 84 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 30f5adb..36b3d5a 100644
--- a/README.md
+++ b/README.md
@@ -2,4 +2,66 @@
 
 Ohayo Dash is a Kubernetes driven start page and dashboard. All configuration is done by standard Kubernetes objects and ConfigMaps.
 
-This is inspired by [Hajimari](https://github.com/toboshii/hajimari) and [SUI](https://github.com/jeroenpardon/sui) projects.
\ No newline at end of file
+This is inspired by [Hajimari](https://github.com/toboshii/hajimari) and [SUI](https://github.com/jeroenpardon/sui) projects.
+
+## Ingresses
+
+All namespaces as processed by default, only Ingress objects with `ohayodash.github.io/enabled` annotation are then displayed.
+
+Annotations can be used to customize the display of the Ingress objects:
+
+* `ohayodash.github.io/name` - Display name of the app, defaults to the Ingress name.
+* `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
+
+Bookmark are stored in `ConfigMap` resources, which are identified by the `ohayodash.github.io/bookmarks` annotation.
+
+Values are pulled from the `bookmarks` key in the config map, which consists of a list of objects with the following keys:
+
+* `name` - the display name of the link
+* `url` - the target URL.
+* `group` - the name the link is to be grouped under.
+
+```
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: ohayodash-bookmarks
+  namespace: web
+  annotations:
+    ohayodash.github.io/bookmarks: 'true'
+data:
+  bookmarks: |
+    - name: Renovate Dashboard
+      url: "https://app.renovatebot.com/dashboard#github/nikdoof/flux-gitops"
+      group: Github
+```
+
+## Providers
+
+Providers are stored in `ConfigMap` resources, which are identified by the `ohayodash.github.io/providers` annotation.
+
+Values are pulled from the `providers` key in the config map, which consists of a list of objects with the following keys:
+
+* `name` - the display name of the link
+* `url` - the target URL of the service.
+* `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.
+
+```
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: ohayodash-providers
+  namespace: web
+  annotations:
+    ohayodash.github.io/providers: 'true'
+data:
+  providers: |
+    - name: Allmusic
+      url: https://www.allmusic.com/
+      search: search/all/
+      prefix: /a
+```
diff --git a/charts/ohayodash/values.yaml b/charts/ohayodash/values.yaml
index e229ac8..5720301 100644
--- a/charts/ohayodash/values.yaml
+++ b/charts/ohayodash/values.yaml
@@ -38,3 +38,24 @@ ingress:
   # @default -- See values.yaml
   main:
     enabled: false
+
+# configmap:
+#   bookmarks:
+#     enabled: false
+#     annotations:
+#       ohayodash.github.io/bookmarks: "true"
+#     data:
+#       bookmarks:
+#         - name: TV Calendar
+#           url: https://www.pogdesign.co.uk/cat/
+#           group: Tools
+#   providers:
+#     enabled: false
+#     annotations:
+#       ohayodash.github.io/providers: "true"
+#     data:
+#       providers:
+#         - name: Trakt
+#           url: https://trakt.tv/
+#           search: search?query=
+#           prefix: /t