aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorBastien Wirtz <bastien.wirtz@gmail.com>2020-03-22 15:51:54 -0700
committerBastien Wirtz <bastien.wirtz@gmail.com>2020-03-22 17:44:02 -0700
commit22555b55e262a1c3519d422d9c446d2d6cf0c83a (patch)
tree17578ef18d3df51f22c7279f92c535f141b8e3ae /README.md
parent2cf93f388130134d8ff9cf1af7535e21cafc207f (diff)
downloadhomer-22555b55e262a1c3519d422d9c446d2d6cf0c83a.tar.gz
homer-22555b55e262a1c3519d422d9c446d2d6cf0c83a.tar.zst
homer-22555b55e262a1c3519d422d9c446d2d6cf0c83a.zip
Adding contribution guidelines
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 11 insertions, 5 deletions
diff --git a/README.md b/README.md
index 11d4714..5ab7c26 100644
--- a/README.md
+++ b/README.md
@@ -5,9 +5,15 @@ A dead simple static **HOM**epage for your serv**ER** to keep your services on h
5 5
6If 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, ...) 6If 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, ...)
7 7
8![screenshot](https://github.com/bastienwirtz/homer/blob/master/screenshot.png) 8![screenshot](https://raw.github.com/bastienwirtz/homer/master/screenshot.png)
9 9
10## installation 10## Roadmap
11
12- [ ] Colors / theme customization
13- [ ] Enable PWA support (making possible to "install" - add to homescreen - it)
14- [ ] Improve maintenability (external library import & service workers cached file list.)
15
16## Installation
11 17
12### Using docker 18### Using docker
13 19
@@ -17,10 +23,10 @@ sudo docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/
17 23
18### Manually 24### Manually
19 25
20**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`. 26**How to build / install it?** There is no build system (😱), use it like that! It's meant to be stupid simple & zero maintenance required. Just copy the static files somewhere, and visit the `index.html`.
21 27
22 28
23## configuration 29## Configuration
24 30
25Title, icons, links, colors, and services can be configured in the `config.yml` file, using [yaml](http://yaml.org/) format. 31Title, icons, links, colors, and services can be configured in the `config.yml` file, using [yaml](http://yaml.org/) format.
26 32
@@ -113,4 +119,4 @@ If you choose to fetch message information from an endpoint, the output format s
113``` 119```
114 120
115`null` value or missing keys will be ignored and value from the `config.yml` will be used if available. 121`null` value or missing keys will be ignored and value from the `config.yml` will be used if available.
116Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar) 122Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar).