From 7a10057b26e4bb1653f96cbe654a7f63c0631df4 Mon Sep 17 00:00:00 2001 From: "Scott \"R00tPiG Security\" Lindsey (r00tpig)" Date: Tue, 22 Sep 2026 09:58:31 -0400 Subject: [PATCH] docs: bring README.md in line with Standard Readme --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 81a8c06..e845621 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # verae-keep +[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme) + Host keep-alive for Verae workers. Restarts a unit that crashed **unless** the operator console paused or stopped it. **Forgejo:** https://git.georgelambert.org/marchon/verae-keep @@ -44,3 +46,25 @@ Units: NATS (observe only), job-poller, webhook-deliver, archive-aggregator, arc - `GET /health` `GET /status` - `POST /intent/:id` `{"state":"pause|stop|run"}` - `POST /reconcile` + +## Install + +```sh +git clone ssh://git@git.georgelambert.org:2223/marchon/verae-keep.git +cd verae-keep +``` + +## Usage + +```sh +npm install +npm start +``` + +## Contributing + +Questions: open an issue at https://git.georgelambert.org/marchon/verae-keep/issues. Pull requests are accepted. + +## License + +UNLICENSED © George Lambert