From c733030361d16c30a2e1e3709872905bf1384b5e Mon Sep 17 00:00:00 2001
From: Opnxng <opnxng@tuta.io>
Date: Wed, 8 Nov 2023 01:17:14 +0800
Subject: [PATCH] Added example inventory

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

diff --git a/README.md b/README.md
index 4ca7d22..3a06ce9 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,41 @@ The role uses the `wg-quick` control which is also exposed via a Systemd service
     - create-wireguard-mesh-network
 ```
 
+## Example inventory
+
+```
+all:
+  hosts:
+    your-host-1:
+      pipelining: true
+      ansible_ssh_user: root
+      ansible_host: 172.0.0.1
+      ansible_ssh_port: 22
+
+      wireguard_ip: 10.1.0.1
+
+    your-host-2:
+      pipelining: true
+      ansible_ssh_user: root
+      ansible_host: 172.0.0.2
+      ansible_ssh_port: 22
+
+      wireguard_ip: 10.2.0.1
+
+    your-host-3:
+      pipelining: true
+      ansible_ssh_user: root
+      ansible_host: 172.0.0.3
+      ansible_ssh_port: 22
+
+      wireguard_ip: 10.3.0.1
+
+  vars:
+    ansible_become_method: su 
+    wireguard_mask_bits: 24
+    wireguard_port: 51871
+```
+
 ## Credits
 
 This role is based on [Tyler-OBrien/wireguard-mesh-network-ansible](https://github.com/Tyler-OBrien/wireguard-mesh-network-ansible), which is based on [jawher/automation-wireguard](https://github.com/jawher/automation-wireguard).