docs: bring README.md in line with Standard Readme

This commit is contained in:
Scott "R00tPiG Security" Lindsey 2026-09-22 09:58:31 -04:00
commit 4735c501b0

View file

@ -1,6 +1,8 @@
# verae-uptime # verae-uptime
GET-watch the public Verae Time × Zapier doors from a host that is **not** the thing being watched. If NS1 is the only watcher, NS1 dying is silent. [![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
GET-watch the public Verae Time × Zapier doors from a host that is **not** the thing being watched. If NS1 is the...
**Forgejo:** https://git.georgelambert.org/marchon/verae-uptime **Forgejo:** https://git.georgelambert.org/marchon/verae-uptime
**SSH:** `ssh://git@git.georgelambert.org:2223/marchon/verae-uptime.git` **SSH:** `ssh://git@git.georgelambert.org:2223/marchon/verae-uptime.git`
@ -19,3 +21,25 @@ node src/watch.js # loop + http://127.0.0.1:3870/status
State: `~/.verae-uptime/status.json` and `watch.log`. State: `~/.verae-uptime/status.json` and `watch.log`.
This process does **not** speak NATS. This process does **not** speak NATS.
## Install
```sh
git clone ssh://git@git.georgelambert.org:2223/marchon/verae-uptime.git
cd verae-uptime
```
## Usage
```sh
npm install
npm start
```
## Contributing
Questions: open an issue at https://git.georgelambert.org/marchon/verae-uptime/issues. Pull requests are accepted.
## License
UNLICENSED © George Lambert