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

docs: plugins are explicit opt-in — correct the README scale section and plugins config comment

Browse source 
A clean-room install smoke of the published GA pair caught the README telling
scale-up users the native provider is auto-detected. It is not, by design: the
loader (loadPlugins) does no auto-detection — undefined means no plugins, and
only an explicit plugins: ['@soulcraft/cor'] loads the native engine (loud
failure if it can't). The stale comment on the plugins config field in the
public types claimed auto-detection and is corrected to match the loader; one
phrase in the plugin-author guide likewise.
This commit is contained in:
David Snelling 2026-07-02 15:47:31 -07:00
parent 99d526d394
commit e420369850
4 changed files with 21 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/PLUGINS.md
View file

@ -70,7 +70,7 @@ export default myPlugin
### 2. Package exports
Your package must export the plugin as the default export so brainy's auto-detection works:
Your package must export the plugin as the default export so brainy's plugin loader can resolve it:
```typescript
// index.ts