1 files changed, 30 insertions, 0 deletions
diff --git a/roles/hostname/README.md b/roles/hostname/README.md
new file mode 100644
index 0000000..057bce0
--- /dev/null
+++ b/roles/hostname/README.md
@@ -0,0 +1,30 @@
+Hostname
+========
+
+Description
+-----------
+
+The `hostname` role sets the local hostname and generates `/etc/hosts`.
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable         | Default                                 | Description
+-----------------|-----------------------------------------|------------
+`hostname_fqdn`  | `{{ inventory_hostname }}.{{ domain }}` | Fully qualified domain name
+`hostname_short` | `{{ inventory_hostname }}`              | Short hostname
+`hostname_ip`    | `{{ ip }}`                              | IPv4 address
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- name: set hostname
+  hosts: all
+  roles:
+    - hostname
+````