From 12879324c6d0616b70fc124f1d767d17d1b655a4 Mon Sep 17 00:00:00 2001
From: Matthew Slowe <foo@mafoo.org.uk>
Date: Sat, 19 Jun 2021 15:58:35 +0100
Subject: [PATCH] Add aliases to readme

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

diff --git a/README.md b/README.md
index 337dd34..d640703 100644
--- a/README.md
+++ b/README.md
@@ -65,6 +65,20 @@ zones:
         - 10 mta2.example.com
 ```
 
+## Aliases virtual type
+There is a virtual record type `aliases` which is a list of names to CNAME to this record.
+
+For example:
+
+```yaml
+zones:
+  example.com:
+    "@":
+      A: 10.54.22.9
+      aliases:
+        - www
+        - ftp
+```
 # Running
 Invoke the docker container with the input yaml file:
 ```bash