From d13519229bf8313ed388f78966da0b33a64f509b Mon Sep 17 00:00:00 2001
From: redxef <federanko.manuel@gmail.com>
Date: Wed, 7 Jun 2023 23:05:18 +0200
Subject: [PATCH] Add readme.

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7fa5fad
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# tarback
+
+Create a tar archive from remote resources.
+
+This is more or less equivalent to `ssh host tar files | xz | split
+output-file` and its reverse.
+
+Two plugins are available:
+- `ssh` handles all the ssh command and filename escaping necessary
+- `docker` instead of backing up a remote volume, back up a docker volume
+
+## usage
+
+`tarback -p ssh,docker -s 'ssh $user@$host' create "$remote_volume_name" "$local_tar_archive"`
+
+Create a split tar archive of the remote volume, with the extensions `part{a-z,a-z}`.
+
+`tarback -p ssh,docker -s 'ssh $user@$host' restore "$local_tar_archive" "$remote_volume_name"`
+
+Restore the backup to the remote docker volume.