updated readme

1 files changed, 23 insertions, 0 deletions

diff --git a/README.md b/README.md
index 864dfdf..352a16e 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,32 @@
 # zsnap
 
+zsnap is a simple tool to manage periodic snapshots of zfs datasets.
+
+```
+# run daemon
 zsnap [--config zsnap.toml] run
+# create a single snapshot for a given tag and dataset
 zsnap [--config zsnap.toml] snapshot --tag my-tag dataset
+# prune snapshots for a given tag and dataset
 zsnap [--config zsnap.toml] prune [--tag my-tag] [--keep n] dataset
+```
+
+example service file:
+```
+[Unit]
+Description=zsnap
+
+[Service]
+Type=simple
+ExecStart=/usr/bin/zsnap --config /etc/zsnap.toml run
+Restart=on-failure
+RestartSec=5
+
+[Install]
+WantedBy=default.target
+```
 
+example config:
 ```zsnap.toml
 [dataset."blackmesa/k8s"]
 schedules = ["hourly", "daily", "weekly", "monthly"]