From dfb3b5c97b6af3dbe5607ddcd941b342a9cb4d7b Mon Sep 17 00:00:00 2001
From: zamaz <71521611+zachariahmiller@users.noreply.github.com>
Date: Wed, 3 Jul 2024 13:56:22 -0400
Subject: [PATCH] docs:  update readme with ide setup instructions for json
 schema validation (#97)

## Description

update readme with ide setup instructions for json schema validation

## Related Issue

Fixes #
<!-- or -->
Relates to #

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [x] Other (security config, docs update, etc)

## Checklist before merging

- [x] Test, docs, adr added or updated as needed
- [x] [Contributor Guide
Steps](https://github.com/defenseunicorns/uds-package-sonarqube/blob/main/CONTRIBUTING.md#developer-workflow)
followed
---
 .gitignore | 1 +
 README.md  | 4 ++++
 2 files changed, 5 insertions(+)

diff --git a/.gitignore b/.gitignore
index 8151105..8a077a9 100644
--- a/.gitignore
+++ b/.gitignore
@@ -4,6 +4,7 @@
 *.tar.zst
 ~/
 .DS_Store
+.vscode/
 defense-unicorns-distro/preflight.sh
 .terraform
 tmp
diff --git a/README.md b/README.md
index f70d55c..e33ff00 100644
--- a/README.md
+++ b/README.md
@@ -37,3 +37,7 @@ Please see the [CONTRIBUTING.md](./CONTRIBUTING.md)
 
 ## Notes:
 This package is currently using registry1 chart for both flavors. This is because the upstream chart depends on 'hostname' and 'wget' to be available in the images, and the registry1 images do not include these tools.
+
+## Development
+
+When developing this package it is ideal to utilize the json schemas for UDS Bundles, Zarf Packages and Maru Tasks. This involves configuring your IDE to provide schema validation for the respective files used by each application. For guidance on how to set up this schema validation, please refer to the [guide](https://github.com/defenseunicorns/uds-common/blob/main/docs/development-ide-configuration.md) in uds-common.