X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=docs%2Fconfiguration.md;h=a472b416d7ed707946b8d615975d96aa64200355;hb=304362adfd5fe06d7b55fe99087543e09f1ef3d8;hp=81de5904db94c7264b4b6140b43e08366e7aac41;hpb=e3bd2ecc2ca874270282c3c42813b8053d67dcbd;p=github%2Fbastienwirtz%2Fhomer.git

diff --git a/docs/configuration.md b/docs/configuration.md
index 81de590..a472b41 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -66,6 +66,17 @@ colors:
 # Optional message
 message:
   # url: "https://<my-api-endpoint>" # Can fetch information from an endpoint to override value below.
+  # mapping: # allows to map fields from the remote format to the one expected by Homer
+  #   title: 'id' # use value from field 'id' as title
+  #   content: 'value' # value from field 'value' as content
+  # refreshInterval: 10000 # Optional: time interval to refresh message
+  #
+  # Real example using chucknorris.io for showing Chuck Norris facts as messages:
+  # url: https://api.chucknorris.io/jokes/random
+  # mapping:
+  #   title: 'id'
+  #   content: 'value'
+  # refreshInterval: 10000
   style: "is-warning"
   title: "Optional message!"
   icon: "fa fa-exclamation-triangle"
@@ -85,7 +96,7 @@ links:
   # see url field and assets/page.yml used in this example:
   - name: "Second Page"
     icon: "fas fa-file-alt"
-    url: "/page2"
+    url: "#page2"
 
 # Services
 # First level array represents a group.
@@ -93,6 +104,8 @@ links:
 services:
   - name: "Application"
     icon: "fas fa-code-branch"
+    # A path to an image can also be provided. Note that icon take precedence if both icon and logo are set.
+    # logo: "path/to/logo"
     items:
       - name: "Awesome app"
         logo: "assets/tools/sample.png"
@@ -123,7 +136,7 @@ services:
         # background: red # optional color for card to set color directly without custom stylesheet
 ```
 
-If you choose to fetch message information from an endpoint, the output format should be:
+If you choose to fetch message information from an endpoint, the output format should be as follows (or you can [custom map fields as shown in tips-and-tricks](./tips-and-tricks.md#mapping-fields)):
 
 ```json
 {