Add readme
This commit is contained in:
parent
02d2cfa615
commit
1b46334e88
32
README.md
Normal file
32
README.md
Normal file
|
@ -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) + "%");
|
||||
}
|
||||
}
|
||||
```
|
Loading…
Reference in a new issue