also fix paths in worker.js

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

diff --git a/README.md b/README.md
index 40dcdd3aad656d2927466613632d8c703f3105cd..62bbd779a19f85cd217ae3e25c645eebbb2ab7e5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,8 +1,7 @@
 # Homer
-A very simple static HOMepage for your servER.
-Add all your useful service, external links, notes... or anything.
+A dead simple static **HOM**epage for your serv**ER** to keep your services on hand, from a simple `yaml` configuration file.
 
-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 tunneling, ...)
+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)
 
@@ -43,7 +42,7 @@ links:
 
 # Services
 # First level array represent a group.
-# Leave only a "items" key if not using group (group name & icon are optional, section separation will not be displayed).
+# Leave only a "items" key if not using group (group name, icon & tagstyle are optional, section separation will not be displayed).
 services:
   - name: "DevOps"
     icon: "fa-code-fork"
@@ -59,6 +58,8 @@ services:
         logo: "/assets/tools/rabbitmq.png"
         subtitle: "Manage & monitor RabbitMQ server"
         tag: "haproxy"
+        # Optional tagstyle
+        tagstyle: "is-success"
         url: "#"
   - name: "Monitoring"
     icon: "fa-heartbeat"