From cccb522b1edc12c56e20daa9630514438d124399 Mon Sep 17 00:00:00 2001
From: Mirek Kratochvil <exa.exa@gmail.com>
Date: Tue, 8 Apr 2014 18:41:52 +0200
Subject: zb-snap, readme

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

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7a833c8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+
+# ZFS-Backup
+
+The zfs backing-up tool. ha-ha.
+
+## Tools:
+
+- `zb-snap <volume>` creates a snapshot
+- `zb-cleanup <volume> <density>` destroys unnecessary snapshots
+- `zb-pull <volume> <remote_volume> <ssh_options>` pulls most recent snapshot of `remote_volume` to `volume`, using ssh called with `ssh_options`
+- `zb-cron` reads configuration from `/etc/zfs-backup.conf` and executes above 3 commands with config-specified parameters
-- 
cgit v1.2.3