onlineornot 0.0.0-eec0888 → 0.0.0-ffacde3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,31 @@
1
+ <h1 align="center"> ✅ onlineornot </h1>
2
+
3
+ `onlineornot` is a CLI for monitoring your uptime checks on [OnlineOrNot](https://onlineornot.com/).
4
+
5
+ ## Authentication
6
+
7
+ To login, you'll need create an environment variable named `ONLINEORNOT_API_TOKEN`, and set it to an OnlineOrNot API token, which you can find [here](https://onlineornot.com/app/settings/developers).
8
+
9
+ For example:
10
+
11
+ ```bash
12
+ export ONLINEORNOT_API_TOKEN=token-goes-here
13
+ npx onlineornot whoami
14
+ ```
15
+
16
+ If your token is valid, you should see:
17
+
18
+ ```bash
19
+ ✅ onlineornot 0.0.10
20
+ ----------------------
21
+ Getting User settings...
22
+ 👋 You are logged in with an API Token.
23
+ ```
24
+
25
+ ## Quick Start
26
+
27
+ Once you've authenticated, you can run commands:
28
+
29
+ ```
30
+ npx onlineornot checks
31
+ ```