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 e4f08b06b6

View file

@ -1,6 +1,8 @@
# verae-backup
Snapshot and restore **zappier SQLite**, staff IAM data, keep state, fleet-runtime (worm/tree blobs), and JetStream store if present.
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
Snapshot and restore **zappier SQLite**, staff IAM data, keep state, fleet-runtime (worm/tree blobs), and JetStream...
**Forgejo:** https://git.georgelambert.org/marchon/verae-backup
**SSH:** `ssh://git@git.georgelambert.org:2223/marchon/verae-backup.git`
@ -21,3 +23,25 @@ User timer: `systemd/verae-backup.timer` (03:17 UTC). Enable with linger.
Does **not** back up private keys. Restore identityFile **paths** on the operator host by hand.
Does **not** connect to NATS; it copies the JetStream directory if `NATS_STORE` exists.
## Install
```sh
git clone ssh://git@git.georgelambert.org:2223/marchon/verae-backup.git
cd verae-backup
```
## Usage
```sh
# No single entrypoint is declared in this tree.
ls
```
## Contributing
Questions: open an issue at https://git.georgelambert.org/marchon/verae-backup/issues. Pull requests are accepted.
## License
UNLICENSED © George Lambert