docs: bring README.md in line with Standard Readme
This commit is contained in:
parent
d221bc8a69
commit
7a10057b26
1 changed files with 24 additions and 0 deletions
24
README.md
24
README.md
|
|
@ -1,5 +1,7 @@
|
||||||
# verae-keep
|
# verae-keep
|
||||||
|
|
||||||
|
[](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.
|
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
|
**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`
|
- `GET /health` `GET /status`
|
||||||
- `POST /intent/:id` `{"state":"pause|stop|run"}`
|
- `POST /intent/:id` `{"state":"pause|stop|run"}`
|
||||||
- `POST /reconcile`
|
- `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
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue