soulcraft/brainy
2
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

8
RELEASES.md
View file

@ -10,6 +10,14 @@ Full auto-generated changelog: `CHANGELOG.md` · Releases: https://github.com/so
---
## v8.0.8 — 2026-07-02 (docs-only patch on the GA)
Corrects the README's scale-up section: the native provider is **not** auto-detected — plugins are
**explicit opt-in** (`new Brainy({ plugins: ['@soulcraft/cor'] })`; brainy never auto-imports a
package you didn't list, and a listed plugin that fails to load throws rather than silently falling
back to the JS engines). Also fixes the stale `plugins` config comment in the public types and one
phrase in the plugin-author guide. No code change.
## v8.0.7 — 2026-07-02 (GA, npm tag `latest`)
> **Why 8.0.7:** npm permanently retires unpublished version numbers, and `8.0.0`–`8.0.6` were