From 9db89017aba8a59491ce3f783176770eca580ae4 Mon Sep 17 00:00:00 2001 From: David Snelling Date: Fri, 20 Jun 2025 14:40:40 -0700 Subject: [PATCH] **docs(readme): add live demo link and update install script in deploy workflow** ### Changes: - **README.md**: Added a "Live Demo" section with a direct link to the interactive GitHub Pages demo. - **deploy-demo.yml**: Modified dependency installation step to use `npm install --legacy-peer-deps` for compatibility. ### Purpose: Improved documentation by providing direct access to the live demo for better user engagement. Updated the deploy workflow to ensure successful dependency resolution during the setup process. --- .github/workflows/deploy-demo.yml | 3 ++- README.md | 4 ++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/workflows/deploy-demo.yml b/.github/workflows/deploy-demo.yml index 239772a8..cab18bcd 100644 --- a/.github/workflows/deploy-demo.yml +++ b/.github/workflows/deploy-demo.yml @@ -19,7 +19,8 @@ jobs: cache: 'npm' - name: Install dependencies 📦 - run: npm ci + run: npm install --legacy-peer-deps + - name: Build project 🏗️ run: | diff --git a/README.md b/README.md index 832a90a3..d05e31d0 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,10 @@ it gets - learning from your data to provide increasingly relevant results and c - **Model Control Protocol (MCP)** - Allow external AI models to access Brainy data and use augmentation pipeline as tools +## 🚀 Live Demo + +**[Try the live demo](https://soulcraft-research.github.io/brainy/examples/demo.html)** - Check out the interactive demo on GitHub Pages that showcases Brainy's main features. + ## 📊 What Can You Build? - **Semantic Search Engines** - Find content based on meaning, not just keywords