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 8b4297a853

View file

@ -1,5 +1,7 @@
# verae-proxmox
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
Provision an **archive worker LXC** on **NS1.GEORGELAMBERT.ORG** (this box **is** the Proxmox host).
| | |
@ -36,3 +38,25 @@ bash scripts/fetch.sh proxmox-worker
Then enable `px-worker` in `verae-fleet/overlays/ns1/machines.json` and `node src/cli.js ssh-check px-worker`.
Keep on the guest uses `units.px-worker.json` (worm ×1 + tree-node ×1 extra copies). Host keep still runs the NS1 floor of 3.
## Install
```sh
git clone ssh://git@git.georgelambert.org:2223/marchon/verae-proxmox.git
cd verae-proxmox
```
## Usage
```sh
# No single entrypoint is declared in this tree.
ls
```
## Contributing
Questions: open an issue at https://git.georgelambert.org/marchon/verae-proxmox/issues. Pull requests are accepted.
## License
UNLICENSED © George Lambert