From 0fec77057a945e081684f50346cccadd65a35524 Mon Sep 17 00:00:00 2001 From: David Snelling Date: Fri, 20 Jun 2025 14:15:53 -0700 Subject: [PATCH] **docs(readme): improve readability through line wrapping and formatting adjustments** ### 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. --- .github/workflows/github-pages.yml | 4 +- README.md | 337 +++++++++++++++-------------- 2 files changed, 181 insertions(+), 160 deletions(-) diff --git a/.github/workflows/github-pages.yml b/.github/workflows/github-pages.yml index 92b15e63..40f548a2 100644 --- a/.github/workflows/github-pages.yml +++ b/.github/workflows/github-pages.yml @@ -24,8 +24,8 @@ jobs: uses: actions/configure-pages@v4 - name: Upload artifact - uses: actions/upload-pages-artifact@v4 - with: + uses: actions/upload-pages-artifact@v3 + with: path: './examples' # Upload the examples directory - name: Deploy to GitHub Pages diff --git a/README.md b/README.md index 20110220..20e9c2d5 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,13 @@ ## ✨ Overview -Brainy combines the power of vector search with graph relationships in a lightweight, cross-platform database. Whether you're building AI applications, recommendation systems, or knowledge graphs, Brainy provides the tools you need to store, connect, and retrieve your data intelligently. +Brainy combines the power of vector search with graph relationships in a lightweight, cross-platform database. Whether +you're building AI applications, recommendation systems, or knowledge graphs, Brainy provides the tools you need to +store, connect, and retrieve your data intelligently. -What makes Brainy special? It intelligently adapts to your environment! Brainy automatically detects your platform, adjusts its storage strategy, and optimizes performance based on your usage patterns. The more you use it, the smarter it gets - learning from your data to provide increasingly relevant results and connections. +What makes Brainy special? It intelligently adapts to your environment! Brainy automatically detects your platform, +adjusts its storage strategy, and optimizes performance based on your usage patterns. The more you use it, the smarter +it gets - learning from your data to provide increasingly relevant results and connections. ### 🚀 Key Features @@ -31,7 +35,8 @@ What makes Brainy special? It intelligently adapts to your environment! Brainy a - **Persistent Storage** - Data persists across sessions and scales to any size - **TypeScript Support** - Fully typed API with generics - **CLI Tools** - Powerful command-line interface for data management -- **Model Control Protocol (MCP)** - Allow external AI models to access Brainy data and use augmentation pipeline as tools +- **Model Control Protocol (MCP)** - Allow external AI models to access Brainy data and use augmentation pipeline as + tools ## 📊 What Can You Build? @@ -50,7 +55,8 @@ What makes Brainy special? It intelligently adapts to your environment! Brainy a npm install @soulcraft/brainy ``` -TensorFlow.js packages are included as required dependencies and will be automatically installed. If you encounter dependency conflicts, you may need to use the `--legacy-peer-deps` flag: +TensorFlow.js packages are included as required dependencies and will be automatically installed. If you encounter +dependency conflicts, you may need to use the `--legacy-peer-deps` flag: ```bash npm install @soulcraft/brainy --legacy-peer-deps @@ -102,6 +108,7 @@ import { BrainyData } from '@soulcraft/brainy/min' ### Browser Usage ```html +