@soulcraft/cor 3.0.0 → 3.0.1

package/README.md

@@ -29,7 +29,7 @@
 
 ---
 
-[Brainy](https://github.com/soulcraftlabs/brainy) is the open-source knowledge database — vectors, relationships, metadata, and full-text in one MIT-licensed engine. Cor swaps compiled Rust in under every hot path. **No code changes. No configuration.** Add the package and it activates; **remove it and everything keeps working** on the same files, at open-source speed. That's the contract in both directions.
+[Brainy](https://github.com/soulcraftlabs/brainy) is the open-source knowledge database — vectors, relationships, metadata, and full-text in one MIT-licensed engine. Cor swaps compiled Rust in under every hot path. **No code changes. No configuration.** Install it and brainy (≥ 8.0.9) auto-detects it — loudly: activation prints `Providers: 10/10 native`, a missing license warns by name, and a broken install makes `init()` throw rather than quietly run slow. **Remove it and everything keeps working** on the same files, at open-source speed. That's the contract in both directions.
 
 | Brainy runs it as | Cor replaces it with | You get |
 |---|---|---|
@@ -48,18 +48,30 @@ npm install @soulcraft/cor    # or: bun add @soulcraft/cor
 ```
 
 ```typescript
-import { Brainy, NounType } from '@soulcraft/brainy'
+import { Brainy, NounType, VerbType } from '@soulcraft/brainy'
 
 const brain = new Brainy({ storage: { type: 'filesystem', path: './data' } })
-await brain.init() // cor is auto-detected — every hot path is now native
+await brain.init() // cor auto-detected (brainy ≥ 8.0.9) — look for "Providers: 10/10 native"
 
-await brain.add({ data: 'native rust acceleration', type: NounType.Concept })
+const cor = await brain.add({
+  data: 'Cor swaps compiled Rust in under every Brainy hot path',
+  type: NounType.Concept,
+  subtype: 'library',
+  metadata: { layer: 'native', year: 2026 },
+})
+const brainy = await brain.add({
+  data: 'Brainy is the open-source knowledge database',
+  type: NounType.Concept,
+  subtype: 'library',
+  metadata: { layer: 'engine', year: 2026 },
+})
+await brain.relate({ from: cor, to: brainy, type: VerbType.DependsOn, subtype: 'runtime' })
 
 const hits = await brain.find({
-  query: 'fast vector search',     // vector — what it means
-  where: { status: 'active' },     // metadata — pushed INTO the walk
-  connected: { from: teamId },     // graph — what it touches
-})                                 // one call, three indexes, fused
+  query: 'native acceleration',   // vector — what it means
+  where: { layer: 'native' },     // metadata — pushed INTO the walk
+  connected: { to: brainy },      // graph — what it touches
+})                                // one call, three indexes, fused
 ```
 
 **Activate** (paid tiers; free = just use brainy):

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soulcraft/cor",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Native Rust acceleration for Brainy \u2014 SIMD distance, vector quantization, zero-copy mmap, native embeddings. Free tier for storage, Pro license for compute acceleration.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",