init

1 files changed, 30 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..864dfdf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# zsnap
+
+zsnap [--config zsnap.toml] run
+zsnap [--config zsnap.toml] snapshot --tag my-tag dataset
+zsnap [--config zsnap.toml] prune [--tag my-tag] [--keep n] dataset
+
+```zsnap.toml
+[dataset."blackmesa/k8s"]
+schedules = ["hourly", "daily", "weekly", "monthly"]
+recursive = true
+
+[dataset."blackmesa/gitea"]
+schedules = ["hourly", "daily", "weekly", "monthly"]
+
+[schedule.hourly]
+cron = "@hourly"
+keep = 24
+
+[schedule.daily]
+cron = "@daily"
+keep = 7
+
+[schedule.weekly]
+cron = "@weekly"
+keep = 4
+
+[schedule.monthly]
+cron = "@monthly"
+keep = 6
+```