soulcraft/brainy
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases 335 Packages Wiki Activity Actions

docs: update plugin docs to reflect opt-in behavior

Browse source 
Plugins are no longer auto-detected. Updated README and PLUGINS.md
to show explicit plugins config, document all config values, and
fix manual registration example to use brain.use() API.
This commit is contained in:
David Snelling 2026-02-02 09:29:41 -08:00
parent a88268fd25
commit c0bb413a2e
2 changed files with 32 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -576,12 +576,22 @@ const stats = brain.getCacheStats() // Performance insights
### Native Acceleration (Optional)
Install `@soulcraft/cortex` for Rust-powered native acceleration: SIMD distance calculations, native metadata/graph indexes, CRoaring bitmaps, and Candle ML embeddings. Auto-detected — zero configuration required.
Install `@soulcraft/cortex` for Rust-powered native acceleration: SIMD distance calculations, native metadata/graph indexes, CRoaring bitmaps, and Candle ML embeddings.
```bash
npm install @soulcraft/cortex
```
```typescript
const brain = new Brainy({
plugins: ['@soulcraft/cortex']
})
await brain.init()
// [brainy] Plugin activated: @soulcraft/cortex
```
Plugins are opt-in — brainy never auto-imports packages unless you list them in `plugins`.
---
## Benchmarks