docs: bring README.md in line with Standard Readme

This commit is contained in:
Scott "R00tPiG Security" Lindsey 2026-09-22 09:58:30 -04:00
commit f356d8a237

View file

@ -1,6 +1,8 @@
# verae-nats-cluster
Three **distinct Proxmox LXC** guests running **NATS JetStream** as a cluster, on the private bridge only. This is the test stand before the same layout moves to separate hardware.
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
Three **distinct Proxmox LXC** guests running **NATS JetStream** as a cluster, on the private bridge only. This is...
**Forgejo:** https://git.georgelambert.org/marchon/verae-nats-cluster
**SSH:** `ssh://git@git.georgelambert.org:2223/marchon/verae-nats-cluster.git`
@ -74,3 +76,32 @@ Latest run (`20260912T045131Z`):
| Flood 8p 20k×128 B | burst queueing | avg 454 ms |
Hardware move: same three configs, three boxes, private NIC only — change IPs in `cluster.env` and `conf/nats.conf.tmpl`.
## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Install
```sh
git clone ssh://git@git.georgelambert.org:2223/marchon/verae-nats-cluster.git
cd verae-nats-cluster
```
## Usage
```sh
# No single entrypoint is declared in this tree.
ls
```
## Contributing
Questions: open an issue at https://git.georgelambert.org/marchon/verae-nats-cluster/issues. Pull requests are accepted.
## License
UNLICENSED © George Lambert