chore: update readme

toboshii · Aug 20, 2021 · b8d78b6 · b8d78b6
1 parent 229f088
commit b8d78b6
Showing 1 changed file with 32 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -10,6 +10,15 @@
 
 ![User config](https://raw.githubusercontent.com/toboshii/hajimari/main/docs/static/img/screen02.png)
 
+## Features
+- Web search bar
+- Dynamically list apps discovered from Kubernetes ingresses
+- Support for non-Kubernetes apps via custom apps config
+- Customizable list of bookmarks
+- Selectable themes
+- Custom configuration overrides per user/browser
+- Multiple instance support
+
 ## Installation
 
 ### Helm
@@ -20,7 +29,7 @@
 
 `helm install hajimari hajimari/hajimari`
 
-![Helm docs](charts/hajimari)
+[Helm docs](charts/hajimari)
 
 ### Locally
 
@@ -32,6 +41,8 @@ make build
 
 You will need to have `go` installed.
 
+Hajimari will need access to a kubeconfig file for a service account with [access to ingress](charts/hajimari/templates/rbac.yaml) objects.
+
 ## Usage
 
 ### Ingresses
@@ -55,11 +66,12 @@ Hajimari supports the following configuration options that can be modified by ei
 
 |       Field       |                                                Description                                                 |         Default         | Type              |
 | :---------------: | :--------------------------------------------------------------------------------------------------------: | :---------------------: | ----------------- |
-| namespaceSelector | Namespace selector which uses a combination of hardcoded namespaces as well as label selectors             |        any: true        | NamespaceSelector |
-|       title       |                                     Title for the Hajimari instance                                        |        "Hajimari"       | string            |
-|   instanceName    |                                      Name of the Hajimari instance                                         |           ""            | string            |
-|    customApps     |                A list of custom apps that you would like to add to the Hajimari instance                   |           {}            | []CustomApp       |
-|    groups         |                A list of bookmark groups to add to the Hajimari instance                                   |           {}            | []groups          |
+| defaultEnable     |                  Set to true to expose all ingresses in selected namespaces by default                     |          false          | boolean
+| namespaceSelector |      Namespace selector which uses a combination of hardcoded namespaces as well as label selectors        |        any: true        | NamespaceSelector |
+| title             |                                     Title for the Hajimari instance                                        |        "Hajimari"       | string            |
+| instanceName      |                                      Name of the Hajimari instance                                         |           ""            | string            |
+| customApps        |                A list of custom apps that you would like to add to the Hajimari instance                   |           {}            | []CustomApp       |
+| groups            |                A list of bookmark groups to add to the Hajimari instance                                   |           {}            | []groups          |
 
 #### NamespaceSelector
 
@@ -73,7 +85,7 @@ It is a selector for selecting namespaces either selecting all namespaces or a l
 
 *Note:* If you specify both `labelSelector` and `matchNames`, Hajimari will take a union of all namespaces matched and use them.
 
-#### Custom Apps
+#### Custom apps
 
 If you want to add any apps that are not exposed through ingresses or are external to the cluster, you can use the custom apps feature. You can pass an array of custom apps inside the config.
 
@@ -100,7 +112,14 @@ Bookmarks can be added by configuring a list of bookmarks under a group.
 | name              | Name of the bookmark                      | String            |
 | url               | URL of the bookmark                       | String            |
 
-Please note there is no authentication. You might want to run this behind a web server with reverse proxy capabilities.
+### Custom startpage setup
+
+1. Open Hajimari in your browser, click the hamburger menu in the lower lefthand corner.
+2. Modify the options you wish to change in the built-in YAML editor.
+3. Click `Save` and you'll be redirected to your new custom page with a random ID on the URL. Set this page as your homepage/new tab page. For Firefox I recommend the [New Tab Override](https://addons.mozilla.org/en-US/firefox/addon/new-tab-override/) extension for the best experience.
+4. You can make further modifications to this page at anytime under the hamburger menu.
+
+Please note there is no authentication. You might want to run this behind ingress with access restrictions.
 
 ## Contributing
 
@@ -110,6 +129,11 @@ Please make sure to update tests as appropriate.
 
 Run `make help` for information on linting, tests, etc.
 
+## About
+### Why Hajimari?
+
+Hajimari (始まり) is Japanese for `beginnings`. Hajimari's original intended purpose is to be used as a browser startpage, so the name seemed fitting as it's the beginning of all new tabs/windows :)
+
 ## Thank you / dependencies
 
 - [SUI](https://github.com/jeroenpardon/sui) For the great startpage template