X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=f1495495486ad80f6a44dd85572aa743ea100e26;hb=2e7bedd13e0ce409e5bfa45095a9154463257870;hp=62bbd779a19f85cd217ae3e25c645eebbb2ab7e5;hpb=05bdc2680193564dbb8acbd85aa8d79eeec546f5;p=github%2Fbastienwirtz%2Fhomer.git

diff --git a/README.md b/README.md
index 62bbd77..f149549 100644
--- a/README.md
+++ b/README.md
@@ -27,6 +27,7 @@ logo: "assets/homer.png"
 
 # Optional message
 message:
+  # url: "https://<my-api-endpoint>" # Can fetch information from an endpoint to override value below.
   style: "is-warning"
   title: "Optional message!"
   content: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque risus mi, tempus quis placerat ut, porta nec nulla. Vestibulum rhoncus ac ex sit amet fringilla. Nullam gravida purus diam, et dictum felis venenatis efficitur. Aenean ac eleifend lacus, in mollis lectus. Donec sodales, arcu et sollicitudin porttitor, tortor urna tempor ligula."
@@ -85,3 +86,16 @@ services:
         url: "#"
 
 ```
+
+If you choose to fetch message information from an endpoint, the output format should be:
+
+```json
+{
+	"style": null,
+	"title": "Lorem ipsum 42",
+	"content": "LA LA LA Lorem ipsum dolor sit amet, ....."
+}
+```
+
+`null` value or missing keys will be ignored and value from the `config.yml` will be used if available.
+Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar)