Update README instructions

README.md

@@ -1,19 +1,22 @@
 # 💚 Axiom: PromptQL Industry Demo Toolkit
 
-**AI Demonstration with PromptQL**
+## AI Demonstration with PromptQL
 
 ![PromptQL](https://img.shields.io/badge/PromptQL-DDN%203.0-b6fc34)
 ![License](https://img.shields.io/badge/license-MIT-green)
 
 ## 🧰 Prerequisites
+
 The following dependencies are required for running the demos:
+
 - [DDN CLI](https://hasura.io/docs/3.0/reference/cli/installation/) - The command line interface
 - Git LFS (`brew install git-lfs` on macOS) - Required for handling large files
 - Docker and Docker Compose - Necessary for running local environments
 - Node.js - Needed for utility scripts
 - jq - Required for utility scripts (`brew install jq`)
 
 **Optional:**
+
 - Ansible - Only needed for internal presales team infrastructure management
 
 ## 🏁 Quick Start
@@ -24,6 +27,9 @@ git clone [email protected]:hasura/axiom.git
 
 cd axiom/demos/<demo>
 
+# Copy env vars to your demo data generator
+cp .data/.env.template .data/<demo>/.env
+
 # Start the backend data services for the demo
 ddn run dataset-up
 
@@ -32,43 +38,51 @@ ddn run docker-start
 ```
 
 ## 🔍 Overview
+
 Axiom brings PromptQL's capabilities to life through industry-specific demos:
+
 - 🏭 **Ready-to-run industry demos** - Real-world industry use cases with minimal setup
 - 🧪 **Feature testing playground** - New DDN & PromptQL features demonstrated in an example project
 - 🛠️ **Extensible toolkit** - Easy to add new demos and customisations
 
-| Directory | What's Inside | Why It's Awesome |
-|-----------|---------------|------------------|
-| 📁 `demos` | DDN configurations, supergraphs, subgraphs, and connector metadata | The heart of each demo - where DDN metadata resides |
-| 📁 `scripts` | Utility tools and helper scripts | Makes deployment and management simple |
-| 📁 `.data` | Seed data and Docker configurations | Pre-configured data to make demos work out of the box |
-| 📁 `infra` | Ansible playbooks (optional) | For internal presales team infrastructure management |
+| Directory    | What's Inside                                                      | Why It's Awesome                                      |
+| ------------ | ------------------------------------------------------------------ | ----------------------------------------------------- |
+| 📁 `demos`   | DDN configurations, supergraphs, subgraphs, and connector metadata | The heart of each demo - where DDN metadata resides   |
+| 📁 `scripts` | Utility tools and helper scripts                                   | Makes deployment and management simple                |
+| 📁 `.data`   | Seed data and Docker configurations                                | Pre-configured data to make demos work out of the box |
+| 📁 `infra`   | Ansible playbooks (optional)                                       | For internal presales team infrastructure management  |
 
 ## 🌟 Demo Profiles
 
 Axiom comes prebuilt with industry demos. Each demo has its own detailed README with features, datasets, and quickstart instructions:
 
 ### 📱 [Telco](demos/telco/README.md)
+
 Telecommunications solutions with customer management, network operations, and service provisioning.
 
 ### 💰 [AML (Anti-Money Laundering)](demos/aml/README.md)
+
 Compliance and risk management with real-time monitoring and automated flagging.
 
 ### 🏥 [Healthcare](demos/healthcare/README.md)
+
 Patient operations platform with scheduling, case management, and medical reference data.
 
 ### 🛒 [CPG (Consumer Packaged Goods)](demos/cpg/README.md)
+
 Retail operations and execution platform for CPG companies with product management, inventory allocation, and promotional planning.
 
 ### 📊 [GTM (Go-to-Market)](demos/gtm/README.md)
+
 Sales and marketing operations platform with opportunity management, campaign execution, and revenue forecasting.
 
 ### 🔍 [Due Diligence](demos/diligence/README.md)
+
 Financial due diligence platform with valuation operations, financial analysis, and ERP data integration.
 
 ### 👟 [SCO (Supply Chain Operations)](demos/supplychain/README.md)
-End-to-end supply chain management platform with manufacturing, logistics, and e-commerce integration.
 
+End-to-end supply chain management platform with manufacturing, logistics, and e-commerce integration.
 
 ## 🌟 Deployment & Management
 
@@ -98,8 +112,9 @@ The script handles both JWT and No-Auth deployments automatically, making deploy
 
 The [connector cleanup tool](./scripts/connector-delete.sh) helps maintain a tidy cloud environment
 
-> [!CAUTION]
-> **Caution advised:** This operation removes connectors from the cloud supergraph.
+> [!CAUTION] >
+
+**Caution advised:** This operation removes connectors from the cloud supergraph.
 
 ```bash
 # Removing the 20 oldest connector builds
@@ -113,18 +128,23 @@ All demos support multiple authentication modes configured in their `auth-config
 Demos should be configured to allow data access for a non-privileged customer role with a predefined id for simplicity.
 
 ### NoAuth Mode (Default)
+
 - No headers required
 - Default admin role access
 
 ### JWT Mode
+
 JWT mode can be achieved both in PromptQL and DDN by setting the following headers:
+
 - `X-Hasura-Auth-Mode: jwt`
 - `Authorization: Bearer <token>`
 
 ### Token generation
+
 Default functionality creates a token with the following grants:
-* x-hasura-role: customer
-* x-hasura-user-id: 7
+
+- x-hasura-role: customer
+- x-hasura-user-id: 7
 
 ```bash
 cd demos/<demo-name>

demos/aml/README.md

@@ -6,6 +6,7 @@ Anti-money laundering compliance with real-time monitoring and automated flaggin
 
 ```bash
 cd demos/aml
+cp ../../.data/.env.template ../../.data/aml/.env
 ddn run dataset-up
 ddn run docker-start
 ```

demos/cpg/README.md

@@ -6,6 +6,7 @@ Consumer packaged goods retail operations with product management and promotiona
 
 ```bash
 cd demos/cpg
+cp ../../.data/.env.template ../../.data/cpg/.env
 ddn run dataset-up
 ddn run docker-start
 ```

demos/diligence/README.md

@@ -6,6 +6,7 @@ Financial due diligence with valuation operations and ERP data integration.
 
 ```bash
 cd demos/diligence
+cp ../../.data/.env.template ../../.data/diligence/.env
 ddn run dataset-up
 ddn run docker-start
 ```

demos/gtm/README.md

@@ -6,6 +6,7 @@ Go-to-market operations with opportunity management and revenue forecasting.
 
 ```bash
 cd demos/gtm
+cp ../../.data/.env.template ../../.data/gtm/.env
 ddn run dataset-up
 ddn run docker-start
 ```

demos/healthcare/README.md

@@ -6,6 +6,7 @@ Patient operations with scheduling, case management, and medical reference data.
 
 ```bash
 cd demos/healthcare
+cp ../../.data/.env.template ../../.data/healthcare/.env
 ddn run dataset-up
 ddn run docker-start
 ```

demos/supplychain/README.md

@@ -6,6 +6,7 @@ Supply chain operations with manufacturing, logistics, and e-commerce integratio
 
 ```bash
 cd demos/supplychain
+cp ../../.data/.env.template ../../.data/supplychain/.env
 ddn run dataset-up
 ddn run docker-start
 ```

demos/telco/README.md

@@ -6,6 +6,7 @@ Telecommunications operations with customer management, network monitoring, and
 
 ```bash
 cd demos/telco
+cp ../../.data/.env.template ../../.data/telco/.env
 ddn run dataset-up
 ddn run docker-start
 ```