aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorIvan Smirnov <isgsmirnov@gmail.com>2020-05-05 22:51:11 -0700
committerIvan Smirnov <isgsmirnov@gmail.com>2020-05-05 23:05:53 -0700
commitfcf5f412a55b37033006c0c1866bc4693ca8bd57 (patch)
tree9beee74cfb9c039b44d64163f4b961d519dcf689 /README.md
parentb317857892921423479b713fb530f5d07d1f5d82 (diff)
downloadhomer-fcf5f412a55b37033006c0c1866bc4693ca8bd57.tar.gz
homer-fcf5f412a55b37033006c0c1866bc4693ca8bd57.tar.zst
homer-fcf5f412a55b37033006c0c1866bc4693ca8bd57.zip
Add "Style Options" section for bulma CSS
This project uses bulma CSS, but this fact is not obvious without reading the code. This commit adds explicit pointers on how to use the `tagstyle` field.
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index fba8ce3..827226b 100644
--- a/README.md
+++ b/README.md
@@ -127,3 +127,14 @@ If you choose to fetch message information from an endpoint, the output format s
127 127
128`null` value or missing keys will be ignored and value from the `config.yml` will be used if available. 128`null` value or missing keys will be ignored and value from the `config.yml` will be used if available.
129Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar). 129Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar).
130
131### Style Options
132
133Homer uses [bulma CSS](https://bulma.io/), which provides a [modifiers syntax](https://bulma.io/documentation/modifiers/syntax/). You'll notice in the config there is a `tagstyle` option. It can be set to any of the bulma modifiers. You'll probably want to use one of these 4 main colors:
134
135- `is-info` (blue)
136- `is-success` (green)
137- `is-warning` (yellow)
138- `is-danger` (red)
139
140You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state.