From 4e56399189d167da337b166143aac23e74efb421 Mon Sep 17 00:00:00 2001
From: jordanbreen28 <jordan.breen@perforce.com>
Date: Fri, 10 Nov 2023 11:04:51 +0000
Subject: [PATCH] (maint) - Add example matrix

---
 README.md               |  2 +-
 docs/custom_matrix.json | 25 +++++++++++++++++++++++++
 2 files changed, 26 insertions(+), 1 deletion(-)
 create mode 100644 docs/custom_matrix.json

diff --git a/README.md b/README.md
index 914fc327..733f4772 100644
--- a/README.md
+++ b/README.md
@@ -59,7 +59,7 @@ In order to use this new functionality, run:
 
 `$: bundle exec matrix_from_metadata_v2 --custom-matrix matrix.json`
 
-> Note: The file should contain a valid Array of JSON Objects (i.e. `[{"label":"AlmaLinux-8","provider":"provision_service","image":"almalinux-cloud/almalinux-8","machine_type":"n1-standard-2"}, {"label":"RedHat-9-arm","provider":"provision_service","image":"rhel-9-arm64","machine_type":"t2a-standard-2"}, {..}]`), otherwise it will throw an error.
+> Note: The file should contain a valid Array of JSON Objects (i.e. see [here](https://github.com/puppetlabs/puppet_litmus/blob/main/docs/custom_matrix.json)), otherwise it will throw an error.
 
 ## Documentation
 
diff --git a/docs/custom_matrix.json b/docs/custom_matrix.json
new file mode 100644
index 00000000..c84f848f
--- /dev/null
+++ b/docs/custom_matrix.json
@@ -0,0 +1,25 @@
+[
+    {
+        "label":"AlmaLinux-8",
+        "provider":"provision_service",
+        "image":"almalinux-cloud/almalinux-8",
+        "machine_type":"n1-standard-2"
+    },
+    {
+        "label":"RedHat-9",
+        "provider":"provision_service",
+        "image":"rhel-9",
+        "machine_type":"n1-standard-2"
+    },
+    {
+        "label":"RedHat-9-arm",
+        "provider":"provision_service",
+        "image":"rhel-9-arm64",
+        "machine_type":"t2a-standard-2"
+    },
+    {
+        "label":"centos-7",
+        "provider":"docker",
+        "image":"litmusimage/centos-7"
+    }
+]