1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b6505e6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# zfs
+
+## Example playbook
+
+```
+- hosts: foo
+  vars:
+  roles:
+    - role: someone_stole_my_name.zfs
+      vars:
+        zpools:
+          - name: foopool
+            state: present
+            mode: mirror
+            mountpoint: none
+            devices:
+              - ata-ST4000VN006-5CW102_ZW60XPA3
+              - ata-ST4000VN006-5CW102_ZW60XPA5
+
+        zvols:
+          - name: barvool
+            state: present
+            pool: foopool
+            extra_zfs_properties:
+              refquota: 256M
+              dedup: on
+              compression: on
+              mountpoint: /mnt/barvool
+```