Add readme

1 files changed, 39 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9964d6c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# zfs
+
+##### requirements.yml
+
+```yaml
+roles:
+  - src: git+https://git.segundo.io/Ansible/zfs
+    name: zfs
+```
+
+## Example playbook
+
+See [`vars/main.yml`](/Ansible/etc-aliases/tree/vars/main.yml) & [`defaults/main.yml`](/Ansible/etc-aliases/tree/defaults/main.yml)
+
+```
+- hosts: foo
+  vars:
+  roles:
+    - role: 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
+```