From ebeb86d1785b150092b9d986a4b382d14bba03a7 Mon Sep 17 00:00:00 2001 From: David Snelling Date: Fri, 20 Jun 2025 13:50:11 -0700 Subject: [PATCH] **docs(demo): add link to interactive GitHub Pages demo** ### Changes: - Updated `README.md` to include a direct link to the interactive demo hosted on GitHub Pages. - Improved demo instructions with clearer options for trying the live demo or running it locally. - Refined descriptions of demo features such as environment compatibility, noun-verb model, and HNSW search. ### Purpose: Provided a quick access link to the live demo for better discoverability and convenience. Enhanced clarity of instructions to guide users in exploring Brainy's capabilities effectively. --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index da0a7306..4e76ae08 100644 --- a/README.md +++ b/README.md @@ -954,11 +954,14 @@ Before deploying, make sure to configure the appropriate environment variables i The repository includes a comprehensive demo that showcases Brainy's main features: -- `examples/demo.html` - A single demo page with animations demonstrating Brainy's features. Run it with - `npm run demo` (see [demo instructions](README.demo.md) for details): - - How Brainy runs in different environments (browser, Node.js, server, cloud) - - How the noun-verb data model works - - How HNSW search works +- `examples/demo.html` - A single demo page with animations demonstrating Brainy's features. + - **[Try the live demo](https://soulcraft.github.io/brainy/demo.html)** - Check out the interactive demo on GitHub Pages + - Or run it locally with `npm run demo` (see [demo instructions](README.demo.md) for details) + +The demo showcases: + - How Brainy runs in different environments (browser, Node.js, server, cloud) + - How the noun-verb data model works + - How HNSW search works ## Syncing Brainy Instances