David Snelling cfe1fd9e22 **feat: refine README and enhance embedding workflows**

### Changes:
- Updated README.md:
  - Refined the project description to highlight its lightweight and powerful nature.
  - Enhanced feature list, replacing outdated entries with modern updates (e.g., TensorFlow integration replacing LLM creation).
  - Included detailed installation and usage instructions for TensorFlow.js support and embedding workflows.
  - Added "Usage Options" section to define different import methods and supported environments.
  - Expanded "Backup and Restore" details, showcasing CLI and scripting examples.
  - Introduced optimized HNSW indexing for large datasets.
  - Replaced examples with a unified and simplified demonstration approach.
  - Embedded advanced build and environment-specific configurations for better clarity.
- Removed outdated content related to language model generation, including LLM-related commands and examples.
- Added README.demo.md with full instructions for running the interactive demo.

### Purpose:
This update modernizes the documentation and focuses on Brainy’s current capabilities, simplifying onboarding for new users while removing deprecated features. It also streamlines project understanding, enabling developers to better utilize its features in diverse environments.

2025-06-19 15:00:08 -07:00

1.7 KiB

Raw Blame History

Running the Brainy Demo

The Brainy interactive demo showcases the library's features in a web browser. Follow these steps to run it:

Prerequisites

Make sure you have Node.js installed (version 23.11.0 or higher)
Ensure the project is built (npm run build:all)

Running the Demo

Option 1: Using the npm script (recommended)

Run the following command from the project root:

npm run demo

This will start an HTTP server and automatically open the demo in your default browser.

Option 2: Manual setup

Start an HTTP server in the project root:

npx http-server

Open your browser and navigate to: http://localhost:8080/examples/demo.html

Troubleshooting

If you see the error "Could not load Brainy library. Please ensure the project is built and served over HTTP", check the following:

Make sure you've built the project with npm run build:all
Ensure you're accessing the demo through HTTP (not by opening the file directly)
Check your browser's console for additional error messages

If issues persist, try clearing your browser cache or using a private/incognito window.

Build Process

The Brainy library uses a two-step build process:

npm run build - Compiles TypeScript files to JavaScript (used for Node.js environments)
npm run build:browser - Creates a browser-compatible bundle using Rollup

You can run both steps together with:

npm run build:all

The browser bundle is created from examples/browser_compatible_exports.ts, which exports only browser-compatible parts of the library. This ensures that the demo works correctly in browser environments while the full library still works in Node.js environments.

1.7 KiB Raw Blame History