**chore(brainy-models): add version configuration and MIT license**

- Added `.versionrc.json` to define conventional release configurations for `brainy-models-package`:
  - Configured tag prefix as `brainy-models-v`.
  - Defined custom commit message format and section mapping for release notes.
- Added `LICENSE` file with MIT license for legal clarity.
- Updated `README.md`:
  - Adjusted internal NPM script names to use underscore prefix for consistency (`_release:patch`, `_github-release`).

**Purpose**: Establish standardized versioning, licensing, and script conventions for the `brainy-models-package` to improve maintainability and alignment with project standards.
This commit is contained in:
David Snelling 2025-08-01 16:59:31 -07:00
parent b8be0b109c
commit 1bc1f08c4e
3 changed files with 62 additions and 3 deletions

View file

@ -734,7 +734,7 @@ const vector = await db.embed("Some text to convert to a vector")
// Calculate similarity between two texts or vectors
const similarity = await db.calculateSimilarity(
"Cats are furry pets",
"Cats are furry pets",
"Felines make good companions"
)
console.log(`Similarity score: ${similarity}`) // Higher value means more similar
@ -1681,10 +1681,10 @@ If you need more control over the release process, you can use the individual co
```bash
# Update version and generate changelog
npm run release:patch # or release:minor, release:major
npm run _release:patch # or _release:minor, _release:major
# Create GitHub release
npm run github-release
npm run _github-release
# Publish to NPM
npm publish

View file

@ -0,0 +1,38 @@
{
"tagPrefix": "brainy-models-v",
"commitMessageFormat": "chore(brainy-models): release {{currentTag}}",
"types": [
{
"type": "feat",
"section": "Features"
},
{
"type": "fix",
"section": "Bug Fixes"
},
{
"type": "chore",
"hidden": true
},
{
"type": "docs",
"section": "Documentation"
},
{
"type": "style",
"hidden": true
},
{
"type": "refactor",
"section": "Code Refactoring"
},
{
"type": "perf",
"section": "Performance Improvements"
},
{
"type": "test",
"hidden": true
}
]
}

View file

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2025 Soulcraft Research
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.