From 90beae3174d44feeb49a2716c18af69235381f2e Mon Sep 17 00:00:00 2001
From: Alexander Olofsson <alexander.olofsson@liu.se>
Date: Sun, 9 Jul 2023 11:42:17 +0200
Subject: [PATCH] Attach a configuration snippet to the readme

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

diff --git a/README.md b/README.md
index c5e68bb..1a6793e 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,27 @@ This is useful for specifying things like `disk.enableUUID=true` or `svga.autode
 Follow the Foreman manual for [advanced installation from gems](https://theforeman.org/plugins/#2.3AdvancedInstallationfromGems)
 
 
+## Usage
+
+Create a configuration file in the Foreman config folder - e.g. `/etc/foreman/plugins/foreman_vmware_advanced.yaml`  
+In there you can configure any of the values managed by the plugin;
+
+```yaml
+---
+# Additional VMX options
+:vmware_advanced:
+  bios.bootOrder: ethernet0,hdd
+  disk.EnableUUID: 'TRUE'
+  svga.autodetect: 'TRUE'
+  tools.upgrade.policy: upgradeAtPowerCycle
+
+# Enable secureboot on new Windows UEFI VMs
+:vmware_secureboot: true
+# Attach a vTPM to all new VMs
+:vmware_vtpm: true
+```
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ananace/foreman_vmware_advanced
-- 
GitLab