From f356d8a2377f2c1ab9c0d7293f5d45cfb829cc17 Mon Sep 17 00:00:00 2001 From: "Scott \"R00tPiG Security\" Lindsey (r00tpig)" Date: Tue, 22 Sep 2026 09:58:30 -0400 Subject: [PATCH] docs: bring README.md in line with Standard Readme --- README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a73d1fb..4a4333d 100644 --- a/README.md +++ b/README.md @@ -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