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

diff --git a/README.md b/README.md
index f149549..edd7d70 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,23 @@
 # Homer
 A dead simple static **HOM**epage for your serv**ER** to keep your services on hand, from a simple `yaml` configuration file.
 
+**Check out the live demo [here](https://homer-demo.netlify.com/).**
+
 If you need authentication support, you're on your own (it can be secured using a web server auth module or exposing it only through a VPN network / SSH tunnel, ...)
 
 ![screenshot](https://github.com/bastienwirtz/homer/blob/master/screenshot.png)
 
-**How to build / install it? Where is the webpack config?**
-There is no build system (😱), use it like that! It'meant to be stupid simple & zero maintenance required. just copy the static files somewhere, and visit the `index.html`.
+## installation
+
+### Using docker
+
+```sh
+sudo docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets b4bz/homer:latest
+```
+
+### Manually
+
+**How to build / install it?** There is no build system (😱), use it like that! It'meant to be stupid simple & zero maintenance required. just copy the static files somewhere, and visit the `index.html`.
 
 
 ## configuration
@@ -23,7 +34,8 @@ title: "Simple homepage"
 subtitle: "Homer"
 logo: "assets/homer.png"
 # Alternatively a fa icon can be provided:
-# icon: "fas fa-skull-crossbones"
+# icon: "fas fa-skull-crossbones"  
+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:
 
 # Optional message
 message:
@@ -37,6 +49,7 @@ links:
   - name: "ansible"
     icon: "fa-github"
     url: "https://github.com/xxxxx/ansible/"
+    target: '_blank' # optionnal html a tag target attribute
   - name: "Wiki"
     icon: "fa-book"
     url: "https://wiki.xxxxxx.com/"
@@ -55,6 +68,7 @@ services:
         subtitle: "Continuous integration server"
         tag: "CI"
         url: "#"
+        target: '_blank' # optionnal html a tag target attribute
       - name: "RabbitMQ Management"
         logo: "/assets/tools/rabbitmq.png"
         subtitle: "Manage & monitor RabbitMQ server"