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