also fix paths in worker.js

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

diff --git a/README.md b/README.md
index 709423f8aaf7ef5362144d0c948873bdaf1b9973..62bbd779a19f85cd217ae3e25c645eebbb2ab7e5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,14 +1,13 @@
 # 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)
 
 **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`.
- 
+
 
 ## configuration
 
@@ -18,11 +17,13 @@ Title, icons, links, colors, and services can be configured in the `config.yml`
 ```yaml
 ---
 # Homepage configuration
-# See https://fontawesome.com/v4.7.0/icons/ for icons options
+# See https://fontawesome.com/icons for icons options
 
 title: "Simple homepage"
 subtitle: "Homer"
 logo: "assets/homer.png"
+# Alternatively a fa icon can be provided:
+# icon: "fas fa-skull-crossbones"
 
 # Optional message
 message:
@@ -41,13 +42,15 @@ 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"
     items:
       - name: "Jenkins"
         logo: "/assets/tools/jenkins.png"
+        # Alternatively a fa icon can be provided:
+        # icon: "fab fa-jenkins"
         subtitle: "Continuous integration server"
         tag: "CI"
         url: "#"
@@ -55,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"
@@ -79,4 +84,4 @@ services:
         tag: "CI"
         url: "#"
 
-```
\ No newline at end of file
+```