From d34056a7e59eeed48b6044bb7344315129b67a6c Mon Sep 17 00:00:00 2001
From: James Arcus <jimbo@ucc.asn.au>
Date: Tue, 17 Dec 2024 01:28:52 +0800
Subject: [PATCH] Create README.md

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ca172da
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# Member VM Automation
+
+Automates the creation of member VMs based on a template VM in Proxmox.
+
+## How to use
+
+1. Create a branch in the repository and make your desired changes to
+   `membervm_nogui.yml`. If you are requesting a new VM, you can duplicate
+   an existing block and modify to suit.
+2. Create a merge request and request review from a Wheel member.
+3. The CI should run to check your addition was made correctly.
+4. Once approved, your branch will be merged in and your VM will be created
+   automatically within a few minutes.
-- 
GitLab