add readmewiki

1 files changed, 36 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a74ef1b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# avahi
+
+Manage `avahi` service files.
+
+##### requirements.yml
+
+```yaml
+roles:
+  - src: git+https://git.segundo.io/Ansible/avahi
+    name: avahi
+```
+
+### Example playbook
+
+```yaml
+---
+- hosts: foo
+  roles:
+    - role: avahi
+      vars:
+        avahi_service_groups:
+          - filename: smb
+            name: '%h'
+            attributes:
+              replace-wildcards: 'yes'
+            services:
+              - type: _smb._tcp
+                port: 445
+              - type: _device-info._tcp
+                txt-records:
+                  - value: model=TimeCapsule8,119
+              - type: _adisk._tcp
+                txt-records:
+                  - value: dk0=adVN=timemachine,adVF=0x82
+                  - value: sys=waMa=0,adVF=0x100
+```