docs: Fix misleading references to non-existent community packages
- Clearly marked community augmentations as 'Coming Soon!' and ideas - Changed examples to show they are future possibilities, not current packages - Fixed cortex.register() references to use brain.register() consistently - Updated augmentation interface from ISenseAugmentation to IAugmentation - Added proper brain.register() example in augmentation creation section - Added note that community packages are examples of what could be built - Added 'Be the First!' encouragement for community builders This ensures documentation is honest about what exists vs what's possible.
This commit is contained in:
parent
a84aaa7fad
commit
c93df7ee8e
2 changed files with 39 additions and 30 deletions
62
README.md
62
README.md
|
|
@ -315,9 +315,9 @@ import { BrainyData, Cortex } from '@soulcraft/brainy'
|
||||||
const brain = new BrainyData()
|
const brain = new BrainyData()
|
||||||
const cortex = new Cortex()
|
const cortex = new Cortex()
|
||||||
|
|
||||||
// Add premium augmentations (requires Early Access license)
|
// Add premium augmentations (requires Brain Cloud subscription)
|
||||||
cortex.register(new AIMemory())
|
brain.register(new AIMemory())
|
||||||
cortex.register(new AgentCoordinator())
|
brain.register(new AgentCoordinator())
|
||||||
|
|
||||||
// Now your AI remembers everything across all sessions!
|
// Now your AI remembers everything across all sessions!
|
||||||
await brain.add("User prefers TypeScript over JavaScript")
|
await brain.add("User prefers TypeScript over JavaScript")
|
||||||
|
|
@ -353,27 +353,31 @@ await neural.neuralImport('data.csv') // Automatically extracts entities & rela
|
||||||
- ✅ **Simple Search** - Text and vector search
|
- ✅ **Simple Search** - Text and vector search
|
||||||
- ✅ **Graph Traversal** - Relationship queries
|
- ✅ **Graph Traversal** - Relationship queries
|
||||||
|
|
||||||
### 🌟 **Community Augmentations** (Free, Open Source)
|
### 🌟 **Community Augmentations** (Coming Soon!)
|
||||||
```bash
|
|
||||||
npm install brainy-sentiment # Community created
|
|
||||||
npm install brainy-translate # Community maintained
|
|
||||||
```
|
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
import { SentimentAnalyzer } from 'brainy-sentiment'
|
// 🚧 FUTURE: Community augmentations will be available soon!
|
||||||
import { Translator } from 'brainy-translate'
|
// These are examples of what the community could build:
|
||||||
|
|
||||||
cortex.register(new SentimentAnalyzer()) // Analyze emotions
|
// Example: Sentiment Analysis (not yet available)
|
||||||
cortex.register(new Translator()) // Multi-language support
|
// npm install brainy-sentiment
|
||||||
|
// brain.register(new SentimentAnalyzer())
|
||||||
|
|
||||||
|
// Example: Translation (not yet available)
|
||||||
|
// npm install brainy-translate
|
||||||
|
// brain.register(new Translator())
|
||||||
```
|
```
|
||||||
|
|
||||||
**Popular community augmentations:**
|
**Ideas for Community Augmentations:**
|
||||||
- 🎭 Sentiment Analysis
|
*Want to build one of these? We'll help promote it!*
|
||||||
- 🌍 Translation (50+ languages)
|
- 🎭 Sentiment Analysis - Analyze emotional tone
|
||||||
- 📧 Email Parser
|
- 🌍 Translation - Multi-language support
|
||||||
- 🔗 URL Extractor
|
- 📧 Email Parser - Extract structured data from emails
|
||||||
- 📊 Data Visualizer
|
- 🔗 URL Extractor - Find and validate URLs
|
||||||
- 🎨 Image Understanding
|
- 📊 Data Visualizer - Generate charts from data
|
||||||
|
- 🎨 Image Understanding - Analyze image content
|
||||||
|
|
||||||
|
**Be the First!** Create an augmentation and we'll feature it here.
|
||||||
|
[See how to build augmentations →](UNIFIED-API.md#creating-your-own-augmentation)
|
||||||
|
|
||||||
### ☁️ **Brain Cloud** (Optional Add-On)
|
### ☁️ **Brain Cloud** (Optional Add-On)
|
||||||
🌟 **Brainy works perfectly without this!** Brain Cloud adds team features:
|
🌟 **Brainy works perfectly without this!** Brain Cloud adds team features:
|
||||||
|
|
@ -388,7 +392,7 @@ const brain = new BrainyVectorDB({
|
||||||
cloud: { apiKey: process.env.BRAIN_CLOUD_KEY } // Optional
|
cloud: { apiKey: process.env.BRAIN_CLOUD_KEY } // Optional
|
||||||
})
|
})
|
||||||
|
|
||||||
cortex.register(aiMemory) // AI remembers everything
|
brain.register(aiMemory) // AI remembers everything
|
||||||
```
|
```
|
||||||
|
|
||||||
**AI Memory & Coordination:**
|
**AI Memory & Coordination:**
|
||||||
|
|
@ -457,27 +461,31 @@ await brain.connect('brain-cloud.soulcraft.com', {
|
||||||
### Build & Share Your Augmentation
|
### Build & Share Your Augmentation
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { ISenseAugmentation } from '@soulcraft/brainy'
|
import { IAugmentation } from '@soulcraft/brainy'
|
||||||
|
|
||||||
export class MovieRecommender implements ISenseAugmentation {
|
export class MovieRecommender implements IAugmentation {
|
||||||
name = 'movie-recommender'
|
name = 'movie-recommender'
|
||||||
|
type = 'cognition' // sense|conduit|cognition|memory
|
||||||
description = 'AI-powered movie recommendations'
|
description = 'AI-powered movie recommendations'
|
||||||
enabled = true
|
enabled = true
|
||||||
|
|
||||||
async processRawData(data: string) {
|
async processRawData(data: any) {
|
||||||
// Your recommendation logic
|
// Your recommendation logic
|
||||||
const movies = await this.analyzePreferences(data)
|
const movies = await this.analyzePreferences(data)
|
||||||
|
|
||||||
return {
|
return {
|
||||||
success: true,
|
success: true,
|
||||||
data: {
|
data: {
|
||||||
nouns: movies.map(m => m.title),
|
recommendations: movies,
|
||||||
verbs: movies.map(m => `similar_to:${m.genre}`),
|
confidence: 0.95
|
||||||
metadata: { genres: movies.map(m => m.genre) }
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Register with Brainy
|
||||||
|
const brain = new BrainyData()
|
||||||
|
brain.register(new MovieRecommender())
|
||||||
```
|
```
|
||||||
|
|
||||||
**Share with the community:**
|
**Share with the community:**
|
||||||
|
|
|
||||||
|
|
@ -185,9 +185,10 @@ Extend Brainy with custom capabilities.
|
||||||
import { NeuralImport } from '@soulcraft/brainy'
|
import { NeuralImport } from '@soulcraft/brainy'
|
||||||
brain.register(new NeuralImport())
|
brain.register(new NeuralImport())
|
||||||
|
|
||||||
// Register community augmentations
|
// Register community augmentations (when available)
|
||||||
import SentimentAnalyzer from 'brainy-sentiment'
|
// Example: Future community packages
|
||||||
brain.register(new SentimentAnalyzer())
|
// import SentimentAnalyzer from 'brainy-sentiment'
|
||||||
|
// brain.register(new SentimentAnalyzer())
|
||||||
|
|
||||||
// Register your own augmentation
|
// Register your own augmentation
|
||||||
class MyCustomAugmentation {
|
class MyCustomAugmentation {
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue