From 1b46334e88812e15605c60346c2578568c3363e3 Mon Sep 17 00:00:00 2001
From: Ilya <admin@redguy.ru>
Date: Sun, 4 Sep 2022 15:14:11 +0300
Subject: [PATCH] Add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b5a62bc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# UptimeKuma-api
+
+Supports UptimeKuma versions from 1.13.1 to 1.14.1
+
+## Installation
+
+```bash
+npm install uptimekuma-api
+```
+
+## Usage
+
+### Start pushing
+```js
+let kuma = new UptimeKuma("https://kuma.url/");
+
+kuma.startPushing("push code",60);
+```
+
+### Stop pushing
+```js
+kuma.cancelPushing();
+```
+
+### Get statuses
+```js
+for (let x of (await kuma.status())) {
+    for (let monitor of x.monitors) {
+        console.log(monitor.name + " " + monitor.heartbeats[1].status+ " - " + (monitor.uptime*100) + "%");
+    }
+}
+```
\ No newline at end of file