clarify pillar.example and README

README.md

@@ -1,7 +1,8 @@
 # wireguard-formula
 
-This formula is supposed to install WireGuard (usually dkms and utils), and
-create interfaces including peers. Configuration is done via pillar (see below).
+This formula is supposed to install WireGuard (usually dkms and utils), create
+and manage interfaces including peers. Configuration is done via pillar (see
+below).
 
 **Attention**: WireGuard is not yet included in the linux mainline kernel. Also,
 the installation is different on every distribution and sometimes you even have
@@ -30,21 +31,7 @@ states youself.
 Some keys can be present in the config file multiple times. To do this, you can
 start a list under a key. If the configuration format allows a single comma
 separated string for the respective key, they all will appear in the config
-file.
-```
-wireguard:
-  interfaces:
-    wgtest:
-      config:
-        DNS:
-	  - 8.8.8.8
-	  - 1.1.1.1
-	DNS: 9.9.9.9, 1.0.0.1
-	Address: fe80::1, fe80::2
-	Address:
-	  - fe80::3
-	  - fe80::4
-```
+file. Also see `pillar.example`.
 
 # Available states
 
@@ -52,8 +39,6 @@ No states. Include `wireguard` in the top.sls file.
 
 ```
 base:
-[... snip ...]
   'some_minion':
     - wireguard
-[... snip ...]
 ```

pillar.example

@@ -10,12 +10,13 @@ wireguard:
       #enable: True
 
       config:
-        # see wg(8) and wg-quick(8) for supported keys. We use all lowercase
-        # letters.
+        # see wg(8) and wg-quick(8) for supported keys.
 
+        # wg genkey
         PrivateKey: private_key_string
 
-        # address must be a list of strings or a comma separated string
+        # Address accepts a list of addresses or a string. Additionally wg-quick
+        # will expand comma separated addresses.
         Address:
           - fe80::1/64
           - 10.0.0.1/24