Update Readme

Update for the new project structure.

Author: elliot-huffman

Readme.md

@@ -2,43 +2,71 @@
 
 [![Validate OpenAPI Spec Files](https://github.com/Software-Hardware-Integration-Lab/OpenAPI/actions/workflows/Validate.yml/badge.svg)](https://github.com/Software-Hardware-Integration-Lab/OpenAPI/actions/workflows/Validate.yml)
 
-This repository contains the OpenAPI specifications for SHI International Corp's APIs. These specifications are used to define the structure and behavior of our APIs, enabling seamless integration and interaction between different services within the SHI ecosystem.
+This repository contains the OpenAPI specifications for SHI International Corp's APIs. These specifications define the structure and behavior of our APIs, enabling seamless integration and interaction between different services within the SHI ecosystem.
 
-## Add Submodule
+## Repository Structure
 
-This repository serves as a submodule in other SHI International Corp. projects, allowing for easy access to the API specifications. The specifications are used to automatically generate boilerplate code, aiding in the development and maintenance of our services.
+```text
+.
+├── specs/                  # Raw OpenAPI specification files (JSON format)
+├── src/
+│   ├── dataGateway/        # Source code and SDK for Data Gateway
+│   └── shield/             # Source code and SDK for SHIELD
+└── .github/workflows/      # CI/CD workflows for validation and SDK generation
+```
+
+- `specs/`: Contains raw OpenAPI specification files in JSON format. These files serve as the source of truth for our APIs and are used to automatically generate SDKs.
+
+- `src/`: Contains SDK implementations automatically generated from the OpenAPI specifications using [Kiota](https://github.com/microsoft/kiota).
+
+## Using the Specifications
+
+### Accessing Raw Specifications
+
+The raw OpenAPI specification files are located in the [`specs`](./specs) folder.
+All specifications are provided in JSON format.
 
-All specifications are to be in JSON format, not YAML.
+### Using Published SDK Packages
 
-To use these specifications in your project, follow these steps:
+We provide SDK packages generated from these specifications, available on npm:
 
-1\. **Clone the Repository**: Include this repository as a submodule in your project by running:
+- [SHI - Data Gateway SDK](https://www.npmjs.com/package/@shi-corp/sdk-data-gateway)
+- [SHIELD SDK](https://www.npmjs.com/package/@shi-corp/sdk-shield)
+
+You can install these packages using npm:
 
 ```bash
-git submodule add https://github.com/Software-Hardware-Integration-Lab/OpenAPI
+npm install @shi-corp/sdk-data-gateway
 ```
 
-2\. **Accessing API Specifications**: The API specifications are located in the root directory. Refer to the specific OpenAPI spec JSON files for detailed API documentation.
+or
+
+```bash
+npm install @shi-corp/sdk-shield
+```
 
-## Update Submodule
+Our packages are cryptographically attested upon publishing, ensuring higher security assurance.
 
-The API specs change over time and it will become necessary to update the specs in various repositories.
+## Development
 
-To do this, execute the following command in the project's root directory:
+To regenerate SDKs from the OpenAPI specifications, use the provided scripts in each SDK's directory:
 
 ```bash
-git submodule update --recursive --remote
+npm run-script generate:Sdk
 ```
 
+## Security Assurance
+
+All SDK packages published by SHI International Corp. are cryptographically attested during the publishing process. This ensures the integrity and authenticity of the packages you consume.
+
 ## Contributing
 
-We welcome contributions and feedback on our API specifications. If you would like to propose changes or improvements, please follow these steps:
+To contribute to the specifications or SDKs:
 
 1. Fork the repository and create a new branch for your changes.
-2. Make the necessary modifications to the API specifications.
+2. Make the necessary modifications to the API specifications or SDK generation scripts.
 3. Submit a pull request detailing the changes made and the rationale behind them.
 
 ## See Also
 
 - [SHI Lab - Documentation](https://docs.shilab.com)
-- [SHI Lab - GitHub](https://github.com/Software-Hardware-Integration-Lab)