From 42b9720e36289e8881f000f5b4f0ae44dcb39d1a Mon Sep 17 00:00:00 2001
From: lavenderguitar <jlavend1@gmail.com>
Date: Sun, 16 Jan 2022 23:43:54 -0500
Subject: [PATCH] v1.0

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..da1d668
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+Uptime Kuma - Ansible
+======================
+
+This configuration repo installs the open-source tool [Uptime Kuma](https://github.com/louislam/uptime-kuma) on Ubuntu distributions (tested for 18.04 and 20.04).
+
+After installation, the service will be available on `127.0.0.1:3001`. A reverse-proxy, such as NGINX or Caddy, can be used to route requests to this endpoint.
+
+Role Variables
+-------------
+
+    kuma__user: kuma
+    kuma__group: {{ kuma__user }}
+
+    # Kuma requires node and npm. If nodejs is not installed, this flag can be used for quick installation of Node v14.
+    kuma__install_nodejs: true
+    nodejs__version: '14.x'
\ No newline at end of file