From 08f531725fa32223b71de2f1e89d4b00e6f2521d Mon Sep 17 00:00:00 2001
From: samuel-p <codes@samuel-philipp.de>
Date: Thu, 27 Feb 2020 21:25:42 +0100
Subject: [PATCH] updated README.md

---
 README.md | 47 ++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 46 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 5e65976..f7d8d45 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,15 @@
-# cachet-monitor
+# [cachet-monitor](https://git.sp-codes.de/samuel-p/cachet-monitor)
+
+[![Build Status](https://ci.sp-codes.de/api/badges/samuel-p/cachet-monitor/status.svg)](https://ci.sp-codes.de/samuel-p/cachet-monitor) ![Docker Pulls](https://img.shields.io/docker/pulls/samuelph/cachet-monitor)
 
 Simple monitor to watch URLs (`HTTP`) or ports (`TCP`, `UDP`) and update Cachet status.
 
 ## Configuration
 
+cachet-monitor can monitor a list of services. Therefore it requires to setup all services in `./data/config.json`. __The id of each service has to match the cachet component id you want to update!__ You also can specify a custom timeout in seconds for each service.
+
+You also need to specify the interval (`cron`) your services should be checked. You can use the cron syntax from [`node-cron`](https://www.npmjs.com/package/node-cron). You also have to set `offlineTimeUntilMajor` which is the offline time in seconds until the state of an offline service turns from partial to major outage. Finally you need to provide the information to your cachet instance (`api` and `token`).
+
 Example:
 
 ```json
@@ -29,3 +35,42 @@ Example:
 	"token": "<user-token>"
 }
 ```
+
+## Run with docker
+
+You can use the docker image [`samuelph/cachet-monitor`](https://hub.docker.com/r/samuelph/cachet-monitor) and mount a volume to `/monitor/data` to persist cache and config:
+
+```bash
+docker run -v /your/path//monitor/data:/monitor/data samuelph/cachet-monitor
+```
+
+You also can use it in `docker-compose.yml`:
+
+```yaml
+services:
+  monitor:
+    image: samuelph/cachet-monitor
+    restart: always
+    volumes:
+      - /home/tux/status/monitor:/monitor/data
+```
+
+## Run from source
+
+1. clone the repo
+
+   ```bash
+   git clone https://git.sp-codes.de/samuel-p/cachet-monitor.git
+   ```
+
+2. install dependencies
+
+   ```bash
+   npm install
+   ```
+
+3. run
+
+   ```bash
+   npm run start
+   ```
\ No newline at end of file