aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1cd5b1e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+ZFS File Diff:
+==============
+
+Instead of operating at a dataset level, ZFS File Diff provides extra tools
+for operating on single files within a snapshot.
+
+This is useful when you:
+- Accedently deleted a file
+- Identify the changes file over time
+
+```
+zfdiff list [--with-paths|-p] <reference>
+zfdiff cat <snap> <reference>
+zfdiff overwrite <snap> <reference>
+zfdiff diff <snap>..<snap> <reference>
+``` \ No newline at end of file