From f0f8b800ba62a8f20bf851911d3a44a9468f5a5d Mon Sep 17 00:00:00 2001
From: Carlo Mandelli
Date: Sun, 8 Aug 2021 10:12:42 +0200
Subject: [PATCH] add badge and demo link
---
README.md | 9 +++++++--
1 file changed, 7 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 5f669df..09bd604 100755
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
# Home Dashboard
+[![Release](https://github.com/camandel/home-dashboard/actions/workflows/release.yml/badge.svg)](https://github.com/camandel/home-dashboard/actions/workflows/release.yml)
+
**Home Dashboard** is a simple startpage to keep track of your favourite servers, applications, links and personal tasks. It can be used as your default browser starting page.
This project is based on [SUI](https://github.com/jeroenpardon/sui).
@@ -7,6 +9,9 @@ This project is based on [SUI](https://github.com/jeroenpardon/sui).
+## Try it
+Live demo [here](https://camandel.github.io/home-dashboard/)
+
## Features
- single page application
- TODO tasks list
@@ -36,9 +41,9 @@ mv home-dashboard /var/www/html && systemctl start httpd
```
cd home-dashboard && python -m http.server
```
-If you don't want to setup a web server you can use directly the tiny docker image (only 32 KB) which contains the code and an http server listening on port 8000:
+If you don't want to setup a web server you can use directly the tiny docker image (only 31 KB) which contains the code and an http server listening on port 8000:
```
-docker run --name home-dashboard -v $PWD/conf:/www/conf -p 8000:8000 -d camandel/home-dashboard
+docker run --name home-dashboard -v :/www/conf -p 8000:8000 -d camandel/home-dashboard
```
## Configuration