### Changes:
- **README.md**:
- Updated `Brainy Logo` image URL to reference a specific commit for consistent display.
- Simplified the description by removing "lightweight" for a more concise statement.
- **package.json**:
- Added `brainy.png` to the `files` array to include it in published packages.
- **src/utils/version.ts**:
- Updated `VERSION` constant from `0.9.2` to `0.9.3`.
### Purpose:
Aligned the documentation with a specific asset version for consistent display. Improved package completeness by including the project logo. Incremented the version to `0.9.3` to reflect the latest changes.
### Changes:
- **README.md**:
- Replaced local image path for `Brainy Logo` with a GitHub raw URL to ensure accessibility in remote contexts.
- Updated links to reference `demo` folder structure (`examples/simplified-augmentations.js` → `demo/simplified-augmentations.js`, `examples/demo.html` → `demo/index.html`).
### Purpose:
Enhanced documentation by ensuring that assets and links are accessible remotely and aligned with the recent folder structure updates. Improved clarity and consistency with the updated demo setup.
### Changes:
- **README.md**:
- Reformatted "Live Demo" and "Demo" sections for improved readability.
- Adjusted line wrapping to enhance clarity and maintain consistent formatting.
- **.npmignore**:
- Allowed inclusion of `brainy.png` while preserving exclusions for other `.png` files.
- **src/utils/version.ts**:
- Bumped version from `0.9.0` to `0.9.1`.
### Purpose:
Enhanced documentation formatting for better user experience and easier navigation. Updated `.npmignore` to refine file inclusion for package distribution. Incremented version to `0.9.1` to reflect the latest changes.
### Changes:
- **examples/index.html**:
- Introduced a new HTML file that redirects users to `demo.html` using both meta tag and JavaScript.
- **README.md**:
- Updated live demo link to point to the new `examples/` directory and clarified access to both the root directory and `demo.html`.
### Purpose:
Improved user experience by creating a smoother navigation to the demo page and updated documentation to reflect the new entry point of the live demo. Removed redundant `CNAME` file as part of cleanup.
### 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.
### Changes:
- Enhanced deployment section in `README.md`:
- Added instructions for automatic deployment using the included GitHub Actions workflow (`.github/workflows/deploy-demo.yml`).
- Documented steps for configuring a custom domain:
- Pointing CNAME or A records to GitHub Pages.
- Adding a domain via repository settings.
### Purpose:
Improved documentation to guide users in automating GitHub Pages demo deployment and configuring custom domains, simplifying setup and enhancing accessibility for personalized deployments.
### Changes:
- Removed `github-pages.yml` GitHub Actions workflow file.
- Updated `README.md`:
- Added documentation for `npm run deploy:demo` to deploy the demo to GitHub Pages.
- Updated the live demo link to reflect the repository's namespace change.
- Added `gh-pages` dependency (v6.3.0) in `package.json`.
- Introduced `deploy:demo` script in `package.json` for demo deployment.
### Purpose:
Streamlined the demo deployment process by removing the dedicated GitHub Pages workflow and replacing it with a manual deployment script (`npm run deploy:demo`). This enhances developer control while maintaining simplicity in deploying updates to the live demo.
### Changes:
- Reformatted `README.md` for enhanced readability:
- Applied line wrapping to long paragraphs and bullet points.
- Adjusted spacing and indentation for consistent formatting.
- Resolved issues with inconsistent code snippet alignments and metadata formatting.
### Purpose:
Improved the readability and maintainability of the README by standardizing formatting and wrapping long lines. These changes ensure better clarity for users exploring the documentation.
### Changes:
- **README.md**: Corrected the relative path for the live demo link to `examples/demo.html`.
- **github-pages.yml**:
- Updated GitHub Actions steps to their latest versions:
- `actions/checkout@v4`
- `actions/configure-pages@v4`
- `actions/upload-pages-artifact@v3`
- `actions/deploy-pages@v4`
- Ensured compatibility with the latest versions of the workflow actions.
### Purpose:
Fixed a broken link in the README for better user accessibility to the demo. Updated workflow actions in `github-pages.yml` to leverage the latest performances and features.
### 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.
### Changes:
- Enhanced README with new feature highlights:
- Added the "Model Control Protocol (MCP)" feature to emphasize external AI model integration.
- Expanded "What Can You Build?" section with model-integrated systems use-case examples.
- Documented the new simplified augmentation system in detail:
- Provided examples for creating augmentations, adding WebSocket support, processing static data, and building reusable pipelines.
- Introduced a streamlined API for managing static and streaming data workflows, augmentations, and dynamic loading.
- Unified terminology by replacing `augmentationPipeline` references with `pipeline`.
### Purpose:
Updated the README to align with recent advancements in the augmentation system and provide users with actionable, hands-on guidance. These changes improve clarity, usability, and awareness of new framework capabilities such as MCP integration and the refined augmentation system.
### Changes:
- Updated the README to simplify descriptions and remove redundant details:
- Reduced verbosity in feature highlights, focusing on core functionality.
- Streamlined examples and usage sections for greater clarity.
- Simplified installation and quick start instructions.
- Removed overly casual or playful language to adopt a more professional tone.
- Consolidated streaming, environment detection, and build system explanations.
- Improved formatting consistency across sections:
- Aligned headings, examples, and lists for readability.
- Adjusted code indentation and structure in examples.
### Purpose:
Enhanced the README to provide a concise, focused, and professional presentation of Brainy. These changes improve readability, simplify onboarding for new users, and ensure consistency with recent terminology and documentation standards.
### Changes:
- **README Enhancements**:
- Added detection capabilities for browser, Node.js, and serverless environments with optimized configuration.
- Expanded details on adaptive storage strategies based on the detected environment.
- Included new information on the Model Control Protocol (MCP), including components like `BrainyMCPAdapter` and `MCPAugmentationToolset`.
- **Terminology Updates**:
- Replaced "restore sparse data" terminology with "import sparse data" in code samples and CLI commands for clarity (e.g., `importSparseData` method and `brainy import-sparse` command).
- Updated related examples for consistency with new term usage.
- **Cross-Environment Compatibility**:
- Highlighted dynamic imports and storage migration for seamless operation in different environments.
- Described augmented browser support and streamlined development practices.
- **MCP Documentation**:
- Detailed REST and WebSocket APIs for interacting with Brainy through MCP.
- Outlined configuration options like rate limiting and authentication for MCP services.
- **cloud-wrapper/README.md**:
- Added configuration details for MCP services, including specific usage of ports, API keys, and CORS settings.
- Expanded API scopes by introducing MCP-related endpoints for real-time and batch interactions.
### Purpose:
Enhanced documentation to reflect recent updates to environment detection, storage optimization, and MCP services. The changes improve clarity, usability, and developer understanding across environments and interaction protocols.
### Changes:
- Expanded cloud deployment section in `README.md`:
- Added detailed npm scripts for deploying to AWS, Google Cloud, and Cloudflare.
- Described script usage for each cloud platform.
- Included instructions for configuring environment variables in `cloud-wrapper/.env`.
- Linked to the Cloud Wrapper README for additional setup and API documentation.
### Purpose:
Improved clarity and usability of cloud deployment instructions by providing specific npm script commands and configuration guidance. This helps streamline the deployment process for users across multiple cloud platforms.
### 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.
### Changes:
- Adjusted the main project description in `README.md` for a more engaging tone by adding "A fun" to emphasize the platform's appeal.
### Purpose:
This update aims to make the project description more approachable and engaging for potential users while maintaining clarity about its capabilities.
Introduced `encode-image.js` to convert images to Base64 and create corresponding HTML `<img>` tags. Outputs a sample encoded result to `encoded-image.html`.
Standardized documentation by adding a centered Brainy logo across README files, examples, and guides. Adjusted text formatting for consistency, improved alignment, and readability of feature descriptions and examples.
Introduced `llm-augmentation.md`, detailing the creation, training, testing, exporting, and deployment of language models using Brainy's graph database. Added examples showcasing practical usage and pipeline integration. Included class implementations in `llmAugmentations.ts`.
Added several badges for TypeScript, TensorFlow, and Cartographer. Expanded on iConduit augmentations with WebSocket and WebRTC details, revised feature descriptions, and introduced a related projects section. Updated examples for improved clarity.
Introduced a cloud deployment wrapper for Brainy supporting AWS Lambda, Google Cloud Run, and Cloudflare Workers. Added configuration options, deployment scripts, and API reference. Updated `README.md` with contribution guidelines and cloud deployment documentation.
Incremented version to 0.7.5 across `version.ts` and `README.md`. Introduced WebSocket and WebRTC conduit augmentations in codebase and documented usage examples thoroughly in `README.md`.
Rebranded from "Soulcraft Brainy" to "Brainy" throughout `README.md`. Improved readability by reformatting long paragraphs and restructuring lists for better clarity.
Upgraded minimum Node.js version from 18.0.0 to 23.11.0 across `README.md`, `package.json`, and `version.ts`. Optimized distance utilities and pipelines to leverage Node.js 23.11+ native performance improvements (e.g., `array.reduce`, WebStreams API). Incremented version to 0.7.4 for consistency.
Updated `README.md` to reflect version `0.7.3` with improved feature descriptions and scaling highlights. Enhanced the versioning script to automatically update the version badge in `README.md` for consistency. Incremented `version.ts` to `0.7.3`.
Enhanced the `README.md` with more engaging and user-friendly descriptions, highlighting Brainy's adaptability and intelligence. Introduced new sections detailing adaptive intelligence, data pipeline enhancements, and use case expansion. Removed outdated dependencies from `package-lock.json`. Updated `version.ts` to `0.7.2`.
Introduced `generateRandomGraph` method to create randomized graphs with configurable entity counts and types, supporting automated testing and experimentation. Enhanced metadata vectorization logic to handle various metadata formats reliably, ensuring compatibility and fallback mechanisms during embedding. Updated `README.md` with detailed feature descriptions and usage guides.
Enhanced the installation section with guidance on resolving TensorFlow.js dependency conflicts using `--legacy-peer-deps`. Added CLI autocomplete setup instructions to improve user experience. Suppressed specific TensorFlow.js Node.js backend warnings in the embedding utils. Updated dependencies to the latest versions.
Added a comprehensive command-line interface (CLI) for interacting with the Brainy vector database. The CLI supports various operations, including database initialization, adding/searching nouns, managing relationships, and querying database status. Enhanced type validation logic for nouns and verbs to ensure consistency and enforce default types for invalid inputs. Updated test scripts to verify type validation and edge cases.
Expanded the documentation to include comprehensive usage scenarios, advanced configurations, and clearer explanations of Brainy's capabilities. Improved formatting and structure for better readability and accessibility.
Introduced configurable read-only mode for databases to restrict write operations. Added support for S3-compatible storage services, including Cloudflare R2, Amazon S3, and Google Cloud Storage. Updated `README.md` with usage examples and configuration details.
Commented out all Firestore-related code across the project, including sync, storage, and vector search features. Removed Firebase dependencies (`firebase`, `firebase-admin`) from `package.json`. Updated `README.md` to reflect the temporary unavailability of Firestore features.
Introduced Firestore vector search integration using `@firebase/firestore-vector-search`. Added support for restricting searches by specific noun types to optimize performance and relevance. Updated `README.md` to document the new functionality and usage examples.
Applied consistent indentation and line-breaking rules to code and text sections in `README.md`, ensuring better formatting and alignment for readability. No functional changes made.
Deleted `examples/externalPlugins.js` and `pluginLoader.ts` as they are no longer used. Updated all `.ts` imports to `.js` across the codebase. Added `MemberOf` to `VerbType` and filtered disabled augmentations in `executeAugmentationPipeline`. Updated documentation to reflect new augmentation registration process. Removed deprecated `allowImportingTsExtensions` from `tsconfig.json`.
