chore: update README.md and docs with Brainy logo and enhanced formatting

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.

CONTRIBUTING.md

@@ -1,11 +1,17 @@
+<div align="center">
+<img src="brainy.png" alt="Brainy Logo" width="200"/>
+
 # Contributing to Soulcraft Brainy
 
+</div>
+
 Thank you for your interest in contributing to Soulcraft Brainy! This document provides guidelines and instructions for
 contributing to the project.
 
 ## Commit Message Guidelines
 
-When contributing to this project, please write clear and descriptive commit messages that explain the purpose of your changes. Good commit messages help maintainers understand your contributions and make the review process smoother.
+When contributing to this project, please write clear and descriptive commit messages that explain the purpose of your
+changes. Good commit messages help maintainers understand your contributions and make the review process smoother.
 
 ### Best Practices
 

README.md

@@ -1,14 +1,11 @@
 <div align="center">
 
-# 🧠 Brainy
+<img src="brainy.png" alt="Brainy Logo" width="200"/>
 
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
 [![Node.js](https://img.shields.io/badge/node-%3E%3D23.11.0-brightgreen.svg)](https://nodejs.org/)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.1.6-blue.svg)](https://www.typescriptlang.org/)
-[![npm package](https://img.shields.io/badge/npm-@soulcraft/brainy-blue)](https://www.npmjs.com/package/@soulcraft/brainy)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
-[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
-[![TensorFlow](https://img.shields.io/badge/TensorFlow-4.22.0-orange.svg)](https://www.tensorflow.org/)
 [![Cartographer](https://img.shields.io/badge/Cartographer-Official%20Standard-brightgreen)](https://github.com/sodal-project/cartographer)
 
 **A powerful, lightweight vector & graph database for browsers and Node.js**
@@ -35,7 +32,8 @@ and connections.
 - **Extensible Augmentations** - Customize and extend functionality with pluggable components (LEGO blocks for your
   data!)
 - **Built-in Conduits** - Sync and scale across instances with WebSocket and WebRTC (your data's teleportation system!)
-- **LLM Creation & Training** - Build, train, and deploy language models from your graph data (your own personal AI factory!)
+- **LLM Creation & Training** - Build, train, and deploy language models from your graph data (your own personal AI
+  factory!)
 - **Adaptive Intelligence** - Automatically optimizes for your environment and usage patterns
 - **Cross-Platform** - Works everywhere you do: browsers, Node.js, and server environments
 - **Persistent Storage** - Data persists across sessions and scales to any size (no memory loss here, even for
@@ -188,8 +186,10 @@ Brainy uses a powerful augmentation system to extend functionality. Augmentation
     - Establishes high-bandwidth channels for structured data exchange
     - Connects with external systems and syncs between Brainy instances
     - Two built-in iConduit augmentations for scaling out and syncing:
-      - **WebSocket iConduit** - Syncs data between browsers and servers (like a digital postal service with superpowers!)
+        - **WebSocket iConduit** - Syncs data between browsers and servers (like a digital postal service with
-      - **WebRTC iConduit** - Direct peer-to-peer syncing between browsers (like telepathy for your data, no middleman required!)
+          superpowers!)
+        - **WebRTC iConduit** - Direct peer-to-peer syncing between browsers (like telepathy for your data, no middleman
+          required!)
     - Examples:
         - Integrating with third-party APIs
         - Syncing Brainy instances between browsers using WebSockets
@@ -682,9 +682,11 @@ Brainy can be deployed as a standalone web service on various cloud platforms us
 - **Google Cloud Run**: Deploy as a containerized service
 - **Cloudflare Workers**: Deploy as a serverless function on the edge
 
-The cloud wrapper provides both RESTful and WebSocket APIs for all Brainy operations, enabling both request-response and real-time communication patterns. It supports multiple storage backends and can be configured via environment variables.
+The cloud wrapper provides both RESTful and WebSocket APIs for all Brainy operations, enabling both request-response and
+real-time communication patterns. It supports multiple storage backends and can be configured via environment variables.
 
 Key features of the cloud wrapper:
+
 - RESTful API for standard CRUD operations
 - WebSocket API for real-time updates and subscriptions
 - Support for multiple storage backends (Memory, FileSystem, S3)
@@ -695,7 +697,8 @@ To get started with cloud deployment, see the [Cloud Wrapper README](cloud-wrapp
 
 ## 🔗 Related Projects
 
-- **[sodal-project cartographer](https://github.com/sodal-project/cartographer)** - The defacto standard for interacting with Brainy
+- **[sodal-project cartographer](https://github.com/sodal-project/cartographer)** - The defacto standard for interacting
+  with Brainy
 
 ## 📚 Examples
 
@@ -712,8 +715,11 @@ The repository includes several examples:
 
 You can use the conduit augmentations to sync Brainy instances:
 
-- **WebSocket iConduit**: For syncing between browsers and servers, or between servers (like a digital postal service with superpowers!). WebSockets cannot be used for direct browser-to-browser communication without a server in the middle.
+- **WebSocket iConduit**: For syncing between browsers and servers, or between servers (like a digital postal service
-- **WebRTC iConduit**: For direct peer-to-peer syncing between browsers (like telepathy for your data, no middleman required!). This is the recommended approach for browser-to-browser communication.
+  with superpowers!). WebSockets cannot be used for direct browser-to-browser communication without a server in the
+  middle.
+- **WebRTC iConduit**: For direct peer-to-peer syncing between browsers (like telepathy for your data, no middleman
+  required!). This is the recommended approach for browser-to-browser communication.
 
 #### WebSocket Sync Example
 
@@ -837,7 +843,8 @@ if (connectionResult[0] && (await connectionResult[0]).success) {
 
 #### Browser-Server Search Example
 
-Brainy supports searching a server-hosted instance from a browser, storing results locally, and performing further searches against the local instance:
+Brainy supports searching a server-hosted instance from a browser, storing results locally, and performing further
+searches against the local instance:
 
 ```typescript
 import {BrainyData} from '@soulcraft/brainy'
@@ -934,7 +941,8 @@ Brainy follows a specific code style to maintain consistency throughout the code
     - Reference issues and pull requests where appropriate
     - Provide detailed explanations in the commit body when necessary
 
-When contributing to the project, please ensure your code follows these guidelines. The project's CI/CD pipeline will automatically check for style violations.
+When contributing to the project, please ensure your code follows these guidelines. The project's CI/CD pipeline will
+automatically check for style violations.
 
 ### Development Workflow
 

cloud-wrapper/README.md

@@ -1,4 +1,8 @@
+<div align="center">
+<img src="../brainy.png" alt="Brainy Logo" width="200"/>
+
 # Brainy Cloud Wrapper
+</div>
 
 A standalone web service wrapper for the [Brainy](https://github.com/soulcraft/brainy) vector graph database. This wrapper allows you to deploy Brainy as a RESTful API service on various cloud platforms including AWS, Google Cloud, and Cloudflare.
 

docs/build-time-augmentations.md

@@ -1,4 +1,8 @@
+<div align="center">
+<img src="../brainy.png" alt="Brainy Logo" width="200"/>
+
 # Build-Time Augmentation Registration
+</div>
 
 This document explains how to register custom augmentations at build time using the Brainy library's augmentation
 registry system.

docs/llm-augmentation.md

@@ -1,4 +1,8 @@
+<div align="center">
+<img src="../brainy.png" alt="Brainy Logo" width="200"/>
+
 # LLM Augmentation for Brainy
+</div>
 
 This document describes the LLM (Language Learning Model) augmentation for Brainy, which enables creating, training, testing, exporting, and deploying language models from the data in Brainy's graph database.
 

examples/README.md

@@ -1,4 +1,8 @@
+<div align="center">
+<img src="../brainy.png" alt="Brainy Logo" width="200"/>
+
 # Brainy Examples
+</div>
 
 This directory contains examples demonstrating various features and use cases of the Brainy vector graph database.
 

examples/browser-server-search/README.md

@@ -1,4 +1,8 @@
+<div align="center">
+<img src="../../brainy.png" alt="Brainy Logo" width="200"/>
+
 # Brainy Browser-Server Search Example
+</div>
 
 This example demonstrates how to use Brainy in a browser, call a server-hosted version for search, store the results locally, and then perform further searches against the local instance.
 

examples/browser-server-search/index.html

@@ -59,7 +59,10 @@
     </style>
 </head>
 <body>
+    <div style="display: flex; align-items: center; margin-bottom: 20px;">
+        <img src="../../brainy.png" alt="Brainy Logo" width="100" style="margin-right: 20px;"/>
         <h1>Brainy Browser-Server Search Example</h1>
+    </div>
 
     <p>
         This example demonstrates how to use Brainy in a browser, call a server-hosted version for search,

examples/demo.html

@@ -12,9 +12,11 @@
             padding: 20px;
             line-height: 1.6;
         }
+
         h1, h2 {
             color: #4361ee;
         }
+
         button {
             background-color: #4361ee;
             color: white;
@@ -24,34 +26,41 @@
             cursor: pointer;
             margin: 5px 0;
         }
+
         button:hover {
             background-color: #3a56d4;
         }
+
         button:disabled {
             background-color: #cccccc;
             cursor: not-allowed;
         }
+
         pre {
             background-color: #f5f5f5;
             padding: 10px;
             border-radius: 4px;
             overflow-x: auto;
         }
+
         .container {
             display: flex;
             flex-direction: column;
             gap: 20px;
         }
+
         .panel {
             border: 1px solid #ddd;
             border-radius: 4px;
             padding: 15px;
         }
+
         .search-container {
             display: flex;
             gap: 10px;
             margin-bottom: 10px;
         }
+
         input, select {
             padding: 8px;
             border: 1px solid #ddd;
@@ -60,8 +69,12 @@
     </style>
 </head>
 <body>
+<div style="display: flex; align-items: center; margin-bottom: 20px;">
+    <img src="../brainy.png" alt="Brainy Logo" width="100" style="margin-right: 20px;"/>
     <h1>Brainy - Vector and Graph Database Demo</h1>
-    <p>This demo shows how to use Brainy as both a vector database (with embeddings and similarity search) and a graph database (with GraphNoun nodes and GraphVerb relationships).</p>
+</div>
+<p>This demo shows how to use Brainy as both a vector database (with embeddings and similarity search) and a graph
+    database (with GraphNoun nodes and GraphVerb relationships).</p>
 
 <div class="container">
     <div class="panel">
@@ -466,12 +479,42 @@
 
             // Define relationships to create
             const relationships = [
-                    { source: 'cat', target: 'dog', type: VerbType.Controls, metadata: { description: 'Cats often dominate dogs in households' } },
+                {
-                    { source: 'tiger', target: 'cat', type: 'relatedTo', metadata: { description: 'Tigers are related to domestic cats' } },
+                    source: 'cat',
-                    { source: 'lion', target: 'tiger', type: VerbType.Controls, metadata: { description: 'Lions are often dominant over tigers in shared territories' } },
+                    target: 'dog',
-                    { source: 'shark', target: 'fish', type: VerbType.Controls, metadata: { description: 'Sharks are predators of many fish species' } },
+                    type: VerbType.Controls,
-                    { source: 'eagle', target: 'bird', type: 'relatedTo', metadata: { description: 'Eagles are a type of bird' } },
+                    metadata: {description: 'Cats often dominate dogs in households'}
-                    { source: 'eagle', target: 'fish', type: VerbType.Controls, metadata: { description: 'Eagles hunt and eat fish' } }
+                },
+                {
+                    source: 'tiger',
+                    target: 'cat',
+                    type: 'relatedTo',
+                    metadata: {description: 'Tigers are related to domestic cats'}
+                },
+                {
+                    source: 'lion',
+                    target: 'tiger',
+                    type: VerbType.Controls,
+                    metadata: {description: 'Lions are often dominant over tigers in shared territories'}
+                },
+                {
+                    source: 'shark',
+                    target: 'fish',
+                    type: VerbType.Controls,
+                    metadata: {description: 'Sharks are predators of many fish species'}
+                },
+                {
+                    source: 'eagle',
+                    target: 'bird',
+                    type: 'relatedTo',
+                    metadata: {description: 'Eagles are a type of bird'}
+                },
+                {
+                    source: 'eagle',
+                    target: 'fish',
+                    type: VerbType.Controls,
+                    metadata: {description: 'Eagles hunt and eat fish'}
+                }
             ];
 
             // Create each relationship

src/augmentations/README.md

@@ -1,4 +1,8 @@
+<div align="center">
+<img src="../../brainy.png" alt="Brainy Logo" width="200"/>
+
 # Brainy Augmentations
+</div>
 
 This directory contains the augmentation implementations for Brainy. Augmentations are pluggable components that extend Brainy's functionality in various ways.