feat: update Node.js requirements to 22 LTS for ONNX compatibility

- Update package.json engines to require Node.js >=22.0.0
- Add .nvmrc file specifying Node.js 22
- Document Node.js version requirements in README
- Add warning about Node.js 24 ONNX runtime compatibility issues
- Provide clear guidance for production deployments

This addresses known crashes during inference operations on Node.js 24
while ensuring maximum stability with the latest LTS version.
This commit is contained in:
David Snelling 2025-08-28 16:05:14 -07:00
parent 8cdd9b2eb3
commit 5cc467f7f6
3 changed files with 14 additions and 1 deletions

1
.nvmrc Normal file
View file

@ -0,0 +1 @@
22

View file

@ -71,6 +71,18 @@ const filtered = await brain.find({
})
```
## 📋 System Requirements
**Node.js Version:** 22 LTS or later (recommended)
- ✅ **Node.js 22 LTS** - Fully supported and recommended for production
- ✅ **Node.js 20 LTS** - Compatible (maintenance mode)
- ❌ **Node.js 24** - Not supported (known ONNX runtime compatibility issues)
> **Important:** Brainy uses ONNX runtime for AI embeddings. Node.js 24 has known compatibility issues that cause crashes during inference operations. We recommend Node.js 22 LTS for maximum stability.
If using nvm: `nvm use` (we provide a `.nvmrc` file)
## 🚀 Key Features
### World's First Triple Intelligence™ Engine

View file

@ -55,7 +55,7 @@
}
},
"engines": {
"node": ">=18.0.0"
"node": ">=22.0.0"
},
"scripts": {
"build": "npm run build:patterns:if-needed && tsc",