]> git.immae.eu Git - github/bastienwirtz/homer.git/commitdiff
Update README.md
authorBastien Wirtz <bastien.wirtz@gmail.com>
Thu, 27 Feb 2020 23:13:48 +0000 (15:13 -0800)
committerGitHub <noreply@github.com>
Thu, 27 Feb 2020 23:13:48 +0000 (15:13 -0800)
README.md

index 409cb5449ff449092bdf03d33d1e46db30bdaf7d..90bbacf1d8ab08eb3c309dfbf84b1c16c0f11f78 100644 (file)
--- 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
 
 ![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`.
+## installation
+
+### Using docker
+
+```sh
+sudo docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml b4bz/homer:latest
+```
+
+### Manually
+
+**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`.
 
 
 ## configuration