From 8fec531a80ed346b88ad0c89fe6a12fd77e53cfd Mon Sep 17 00:00:00 2001
From: kekskurse <git@kekskurse.de>
Date: Mon, 20 Sep 2021 12:51:51 +0200
Subject: [PATCH] dev: ad readme

---
 .goreleaser.yml        |  4 +++-
 Readme.md              | 17 +++++++++++++++++
 test.yml => config.yml |  0
 3 files changed, 20 insertions(+), 1 deletion(-)
 create mode 100644 Readme.md
 rename test.yml => config.yml (100%)

diff --git a/.goreleaser.yml b/.goreleaser.yml
index 9981dbe..4c703ec 100644
--- a/.goreleaser.yml
+++ b/.goreleaser.yml
@@ -47,4 +47,6 @@ nfpms:
     - deb
   contents:
     - src: init/http-server-status.service
-      dst: /etc/systemd/system/http-server-status.service
\ No newline at end of file
+      dst: /etc/systemd/system/http-server-status.service
+    - src: config.yml
+      dst: /etc/http-server-status/config.yml.sample
\ No newline at end of file
diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..8acb2cc
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,17 @@
+# HTTP Server Status
+Status Page for your VM or HDD Server to montiro with an external tool like uptimerobot.com
+
+# Installation
+To Install the Server Montiroing download the last .deb File from the Release page and save it as http-server-status.deb on your server. Than run `dpkg -i http-server-status.deb`.
+
+Copy the config sample and edit the config.
+```bigquery
+cp /etc/http-server-status/config.yml.sample /etc/http-server-status/config.yml
+nano /etc/http-server-status/config.yml
+```
+
+After this start the server
+
+```
+sudo systemctl start http-server-status
+```
\ No newline at end of file
diff --git a/test.yml b/config.yml
similarity index 100%
rename from test.yml
rename to config.yml