Merge pull request #22 from traeblain/feature-title

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

diff --git a/README.md b/README.md
index 409cb5449ff449092bdf03d33d1e46db30bdaf7d..edd7d7071454694b159fc3a9e425896fd88e80d2 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 -v /your/local/assets/:/www/assets 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
@@ -25,7 +34,8 @@ title: "Simple homepage"
 subtitle: "Homer"
 logo: "assets/homer.png"
 # Alternatively a fa icon can be provided:
-# icon: "fas fa-skull-crossbones"
+# icon: "fas fa-skull-crossbones"  
+footer: '<p>Created with <span class="has-text-danger">❤️</span> with <a href="https://bulma.io/">bulma</a>, <a href="https://vuejs.org/">vuejs</a> & <a href="https://fontawesome.com/">font awesome</a> // Fork me on <a href="https://github.com/bastienwirtz/homer"><i class="fab fa-github-alt"></i></a></p>'  # set false if you want to hide it.header:
 
 # Optional message
 message:
@@ -33,7 +43,6 @@ message:
   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."
-  footer: '<p>Created with <span class="has-text-danger">❤️</span> with <a href="https://bulma.io/">bulma</a>, <a href="https://vuejs.org/">vuejs</a> & <a href="https://fontawesome.com/">font awesome</a> // Fork me on <a href="https://github.com/bastienwirtz/homer"><i class="fab fa-github-alt"></i></a></p>'  # set false if you want to hide it.
 
 # Optional navbar
 links: