aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBenjamin Linskey2025-07-30 14:17:58 -0400
committerBenjamin Linskey2025-07-30 14:19:32 -0400
commit2abe7e9aba03cec30136fc075ea3d26f4c6e2bf7 (patch)
tree23d65499d0630e273af8c9da87c19ae392b2748e
parent531bae2df3311efb89f0b27b7dc684079c47a764 (diff)
downloadzfs-snapshots-2abe7e9aba03cec30136fc075ea3d26f4c6e2bf7.tar.gz

Add readme

-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3e803e8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+# ZFS snapshot management script
+
+This is a simple script for creating, pruning, and listing ZFS snapshots. See
+`example.crontab` for a demonstration of how this can be used to configure
+rolling snapshots with a simple retention policy.
+
+This script is lightly tested, and more robust alternatives are available.
+Use at your own risk.