Adding external config support

[github/bastienwirtz/homer.git] / README.md

diff --git a/README.md b/README.md
index 09218c8684846583bcb1ea4b59bd1b7cb2e9a955..c3a6f07590b23878bf70482cadb3ac8fa3cbd23d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -85,6 +85,10 @@ Title, icons, links, colors, and services can be configured in the `config.yml`
 # Homepage configuration
 # See https://fontawesome.com/icons for icons options
 
+# Optional: Use external configuration file. 
+# Using this will ignore remaining config in this file
+# externalConfig: https://example.com/server-luci/config.yaml
+
 title: "App dashboard"
 subtitle: "Homer"
 logo: "assets/homer.png"
@@ -92,7 +96,7 @@ logo: "assets/homer.png"
 # icon: "fas fa-skull-crossbones"
 
 header: true # Set to false to hide the header
-footer: '<p>Created with <span class="has-text-danger">❤️</span> with <a href="https://bulma.io/">bulma</a>, <a href="https://vuejs.org/">vuejs</a> & <a href="https://fontawesome.com/">font awesome</a> // Fork me on <a href="https://github.com/bastienwirtz/homer"><i class="fab fa-github-alt"></i></a></p>' # set false if you want to hide it.header:
+footer: '<p>Created with <span class="has-text-danger">❤️</span> with <a href="https://bulma.io/">bulma</a>, <a href="https://vuejs.org/">vuejs</a> & <a href="https://fontawesome.com/">font awesome</a> // Fork me on <a href="https://github.com/bastienwirtz/homer"><i class="fab fa-github-alt"></i></a></p>' # set false if you want to hide it.
 
 # Optional theming
 theme: default # 'default' or one of the theme available in 'src/assets/themes'.