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 7a10057b26

View file

@ -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