aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorBastien Wirtz <bastien.wirtz@gmail.com>2020-02-27 15:13:48 -0800
committerGitHub <noreply@github.com>2020-02-27 15:13:48 -0800
commitb79e6ed17cf3f06f6e84dff04751df8f17c0f49f (patch)
tree5fcc88ccc2644088bf807188a14efd4db447c790 /README.md
parentdeff5e387a8c29536988db03d0b551d516a79b14 (diff)
downloadhomer-b79e6ed17cf3f06f6e84dff04751df8f17c0f49f.tar.gz
homer-b79e6ed17cf3f06f6e84dff04751df8f17c0f49f.tar.zst
homer-b79e6ed17cf3f06f6e84dff04751df8f17c0f49f.zip
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/README.md b/README.md
index 409cb54..90bbacf 100644
--- a/README.md
+++ b/README.md
@@ -7,8 +7,17 @@ If you need authentication support, you're on your own (it can be secured using
7 7
8![screenshot](https://github.com/bastienwirtz/homer/blob/master/screenshot.png) 8![screenshot](https://github.com/bastienwirtz/homer/blob/master/screenshot.png)
9 9
10**How to build / install it? Where is the webpack config?** 10## installation
11There 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`. 11
12### Using docker
13
14```sh
15sudo docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml b4bz/homer:latest
16```
17
18### Manually
19
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`.
12 21
13 22
14## configuration 23## configuration