Skip to content

Commit

Permalink
add readme
Browse files Browse the repository at this point in the history
Signed-off-by: Austin Abro <[email protected]>
  • Loading branch information
AustinAbro321 committed Aug 15, 2024
1 parent 1b2f7b6 commit d9496f5
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions hack/schema/README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit d9496f5

Please sign in to comment.