Adding more documentation

1 files changed, 100 insertions, 89 deletions

diff --git a/README.md b/README.md
index aa934f7..337fb5d 100644
--- a/README.md
+++ b/README.md
@@ -1,29 +1,39 @@
 # Homer
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Contribution Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
+[![Dowload](https://img.shields.io/badge/Dowload-homer.zip-orange)](https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip)
+[![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/awesome-selfhosted/awesome-selfhosted)
 
-A dead simple static **HOM**epage for your serv**ER** to keep your services on hand, from a simple `yaml` configuration file.
+A dead simple static **HOM**epage for your serv**ER** to keep your s
+ervices on hand, from a simple `yaml` configuration file.
 
-**Check out the live demo [here](https://homer-demo.netlify.app).**
-
-It supports keyboard shortcuts:
+## [Live demo](https://homer-demo.netlify.app).
+![screenshot](https://raw.github.com/bastienwirtz/homer/master/screenshot.png)
 
-- `/` Start searching.
-- `Escape` Stop searching.
-- `Enter` Open the first matching result (respects the bookmark's `_target` property).
-- `Alt`/`Option` + `Enter` Open the first matching result in a new tab.
+## Table of Contents
+- [Features](#features)
+- [Getting started](#getting-started)
+- [Configuration](#configuration)
+- [Roadmap](#roadmap) 
+- [Developement](#developement)
 
-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, ...)
+## Features
+- [yaml](http://yaml.org/) file configuration
+- Installable (pwa)
+- Search
+- Grouping 
+- Theme customization
+- Offline heathcheck
+- keyboard shortcuts:
+  - `/` Start searching.
+  - `Escape` Stop searching.
+  - `Enter` Open the first matching result (respects the bookmark's `_target` property).
+  - `Alt`/`Option` + `Enter` Open the first matching result in a new tab.
 
-![screenshot](https://raw.github.com/bastienwirtz/homer/master/screenshot.png)
 
-## Roadmap
+## Getting started
 
-- [ ] Add more themes.
-- [ ] Add support for custom service card (add custom feature to some service / app link)
-- [x] Colors / theme customization
-- [x] Enable PWA support (making possible to "install" - add to homescreen - it)
-- [x] Improve maintainability (external library import & service workers cached file list.)
-
-## Usage
+Homer is a full static html/js dashboard, generated from the source in `/src` using webpack. It's meant to be served by an HTTP server, **it will not work if you open dist/index.html directly over file:// protocol**.
 
 ### Using docker
 
@@ -31,55 +41,31 @@ If you need authentication support, you're on your own (it can be secured using
 docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets b4bz/homer:latest
 ```
 
-### Manually
-
-Homer is a static page that need to be generated from the source in this repository.
-Use the folowing command to build the project:
+### Using the release tarball (prebuilt, ready to use)
 
+Download and extract the latest the latest release (`homer.zip`) from the [release page](https://github.com/bastienwirtz/homer/releases), rename the `config.yml.dist` file to `config.yml`, and put it behind a webserver.
+ 
 ```sh
-# Using yarn (recommended)
-yarn install
-yarn build
-
-# **OR** Using npm
-npm install
-npm run build
+wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
+unzip homer.zip
+cd homer
+cp config.yml.dist config.yml
+npx serve # or python -m http.server 8010 or apache, nginx ...
 ```
 
-Then your dashboard is ready to use in the `/dist` directory.
-The `dist` directory is meant to be served by an HTTP server, so **it will not work if you open dist/index.html directly over file:// protocol**.
-
-Use it like any static HTML content (use a webserver or open the html index directly).
-
-## Development
+### Build manually
 
 ```sh
 # Using yarn (recommended)
 yarn install
-yarn serve
+yarn build
 
 # **OR** Using npm
 npm install
-npm run serve
-```
-
-### Themes
-
-Themes are meant to be simple customization (written in [scss](https://sass-lang.com/documentation/syntax)).
-To addd a new theme, just add a file in the theme directory, and put all style in the `body #app.theme-<name>` scope. Then import it in the main style file.
-
-```scss
-// `src/assets/themes/my-awesome-theme.scss`
-body #app.theme-my-awesome-theme. { ... }
+npm run build
 ```
 
-```scss
-// `src/assets/app.scss`
-// Themes import
-@import "./themes/sui.scss";
-...
-@import "./themes/my-awesome-theme.scss";
-```
+Then your dashboard is ready to use in the `/dist` directory.
 
 ## Configuration
 
@@ -136,63 +122,51 @@ message:
   # url: "https://<my-api-endpoint>" # Can fetch information from an endpoint to override value below.
   style: "is-warning"
   title: "Optional message!"
-  content: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque risus mi, tempus quis placerat ut, porta nec nulla. Vestibulum rhoncus ac ex sit amet fringilla. Nullam gravida purus diam, et dictum felis venenatis efficitur. Aenean ac eleifend lacus, in mollis lectus. Donec sodales, arcu et sollicitudin porttitor, tortor urna tempor ligula."
+  content: "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
 
 # Optional navbar
 # links: [] # Allows for navbar (dark mode, layout, and search) without any links
 links:
-  - name: "ansible"
+  - name: "Link 1"
     icon: "fab fa-github"
-    url: "https://github.com/xxxxx/ansible/"
+    url: "https://github.com/bastienwirtz/homer"
     target: "_blank" # optional html tag target attribute
-  - name: "Wiki"
+  - name: "link 2"
     icon: "fas fa-book"
-    url: "https://wiki.xxxxxx.com/"
+    url: "https://github.com/bastienwirtz/homer"
 
 # Services
 # First level array represent a group.
 # Leave only a "items" key if not using group (group name, icon & tagstyle are optional, section separation will not be displayed).
 services:
-  - name: "DevOps"
+  - name: "Application"
     icon: "fa fa-code-fork"
     items:
-      - name: "Jenkins"
-        logo: "/assets/tools/jenkins.png"
+      - name: "Awesome app"
+        logo: "assets/tools/sample.png"
         # Alternatively a fa icon can be provided:
         # icon: "fab fa-jenkins"
-        subtitle: "Continuous integration server"
-        tag: "CI"
-        url: "#"
+        subtitle: "Bookmark example"
+        tag: "app"
+        url: "https://www.reddit.com/r/selfhosted/"
         target: "_blank" # optional html tag target attribute
-      - name: "RabbitMQ Management"
-        logo: "/assets/tools/rabbitmq.png"
-        subtitle: "Manage & monitor RabbitMQ server"
-        tag: "haproxy"
+      - name: "Another one"
+        logo: "assets/tools/sample2.png"
+        subtitle: "Another application"
+        tag: "app"
         # Optional tagstyle
         tagstyle: "is-success"
         url: "#"
-  - name: "Monitoring"
+  - name: "Other group"
     icon: "fas fa-heartbeat"
     items:
-      - name: "M/Monit"
-        logo: "/assets/tools/monit.png"
-        subtitle: "Monitor & manage all monit enabled hosts"
-        tag: "monit"
-        url: "#"
-      - name: "Grafana"
-        logo: "/assets/tools/grafana.png"
-        subtitle: "Metric analytics & dashboards"
-        url: "#"
-      - name: "Kibana"
-        logo: "/assets/tools/elastic.png"
-        subtitle: "Explore & visualize logs"
-        tag: "elk"
-        url: "#"
-      - name: "Website monitoring"
-        logo: "/assets/tools/pingdom.png"
-        subtitle: "Pingdom public reports overview"
-        tag: "CI"
-        url: "#"
+      - name: "Another app"
+        logo: "assets/tools/sample.png"
+        subtitle: "Another example"
+        tag: "other"
+        url: "https://www.reddit.com/r/selfhosted/"
+        target: "_blank" # optionnal html a tag target attribute
+      
 ```
 
 If you choose to fetch message information from an endpoint, the output format should be:
@@ -218,3 +192,40 @@ Homer uses [bulma CSS](https://bulma.io/), which provides a [modifiers syntax](h
 - `is-danger` (red)
 
 You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state.
+
+
+## Roadmap
+
+- [ ] Add more themes.
+- [ ] Add support for custom service card (add custom feature to some service / app link)
+
+
+## Development
+
+```sh
+# Using yarn (recommended)
+yarn install
+yarn serve
+
+# **OR** Using npm
+npm install
+npm run serve
+```
+
+### Themes
+
+Themes are meant to be simple customization (written in [scss](https://sass-lang.com/documentation/syntax)).
+To addd a new theme, just add a file in the theme directory, and put all style in the `body #app.theme-<name>` scope. Then import it in the main style file.
+
+```scss
+// `src/assets/themes/my-awesome-theme.scss`
+body #app.theme-my-awesome-theme. { ... }
+```
+
+```scss
+// `src/assets/app.scss`
+// Themes import
+@import "./themes/sui.scss";
+...
+@import "./themes/my-awesome-theme.scss";
+```