From d9496f5aeb859681b9d253737ef8e15c8e05c11b Mon Sep 17 00:00:00 2001
From: Austin Abro <AustinAbro321@gmail.com>
Date: Thu, 15 Aug 2024 16:35:39 +0000
Subject: [PATCH] add readme

Signed-off-by: Austin Abro <AustinAbro321@gmail.com>
---
 hack/schema/README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/hack/schema/README.md b/hack/schema/README.md
index e69de29bb2..a1db2229b2 100644
--- a/hack/schema/README.md
+++ b/hack/schema/README.md
@@ -0,0 +1,12 @@
+# schema generation
+
+This go project is designed to generate the JSON schema for the given API version of zarf.yaml files.
+
+## Usage
+Run the program with the desired API version as an argument:
+```bash
+go run main.go v1alpha1
+```
+The generated JSON schema will be printed to the console.
+
+Alternatively run `./create-zarf-schema.sh` which will generate all of the schemas, add yaml extension, and move the schema files to their proper place in the repo.