From cc2a4c462749abb11008cd93246b5b51a87f5e54 Mon Sep 17 00:00:00 2001
From: Dominic Reber <71256590+domire8@users.noreply.github.com>
Date: Wed, 24 Jan 2024 11:41:21 +0100
Subject: [PATCH] feat: add readme section for bundling schemas (#116)

---
 README.md | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 22275f9a..332a9b5e 100644
--- a/README.md
+++ b/README.md
@@ -14,4 +14,22 @@ See the [python](./python) subdirectory for more information and source code.
 ## Schemas
 
 JSON schemas defining the expected syntax for AICA application files or component descriptions are available
-in the [schemas](./schemas) subdirectory.
\ No newline at end of file
+in the [schemas](./schemas) subdirectory.
+
+### Bundling the schemas locally
+
+In order to bundle the schemas locally for debugging and testing, do the following (replace `<path>` and `<schema>` for the
+desired schema generation):
+
+```bash
+docker build -t aica-technology/api-schema - <<EOF
+FROM node:latest
+WORKDIR /tmp
+COPY . .
+RUN npm install utils
+RUN node utils/bundleHelper.js <path>/<schema>.schema.json <schema>.schema.json
+EOF
+CONTAINER_ID=$(docker run -d aica-technology/api-schema)
+docker cp "${CONTAINER_ID}":/tmp/<schema>.schema.json .
+docker stop "${CONTAINER_ID}"
+```
\ No newline at end of file