From bf8fd3255baa145217c899e751bfe3d625840874 Mon Sep 17 00:00:00 2001
From: Christian Segundo
Date: Fri, 5 May 2023 21:30:39 +0200
Subject: update readme

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 80325f1..23c0eb2 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,26 @@
 # etc-aliases
+
+A role to manage `/etc/aliases` file
+
+##### requirements.yml
+
+```yaml
+roles:
+  - src: git+https://git.segundo.io/Ansible/etc-aliases
+    name: etc-aliases
+```
+
+### Example playbook
+
+See [`vars/main.yml`](/Ansible/etc-aliases/tree/vars/main.yml) & [`defaults/main.yml`](/Ansible/etc-aliases/tree/defaults/main.yml)
+
+```yaml
+---
+- hosts: foo
+  roles:
+    - role: etc-aliases
+      vars:
+        etc_aliases:
+          dmarc: root
+          root: "bar@foo"
+```
-- 
cgit v1.2.3