**chore(version, docs): bump version to 0.9.14 and update build documentation**

- Updated `npm` badge in `README.md` to reflect version `0.9.14`.
- Updated `VERSION` constant in `src/utils/version.ts` to `0.9.14`.
- Replaced `build:all` script references in documentation with separate `build` and `build:browser` commands for better clarity.
- Adjusted `demo` script to build both Node.js and browser versions before running the demo.
- Updated prerequisites in `README.demo.md` to align with the new build workflow.
- Refined `package.json` `files` field to clean up package distribution artifacts.

These changes ensure version consistency, clarify build processes, and improve documentation to streamline the developer experience.
This commit is contained in:
David Snelling 2025-07-02 10:20:58 -07:00
parent 780c4fcf12
commit 84f74048f1
4 changed files with 14 additions and 10 deletions

View file

@ -4,8 +4,8 @@ The Brainy interactive demo showcases the library's features in a web browser. F
## Prerequisites
- Make sure you have Node.js installed (version 23.11.0 or higher)
- Ensure the project is built (`npm run build:all`)
- Make sure you have Node.js installed (version 24.0.0 or higher)
- Ensure the project is built (run both `npm run build` and `npm run build:browser`)
## Running the Demo
@ -51,7 +51,13 @@ The Brainy library uses a two-step build process:
You can run both steps together with:
```bash
npm run build:all
npm run build && npm run build:browser
```
Or simply use the demo script which does this for you:
```bash
npm run demo
```
The browser bundle is created from `src/unified.ts`, which provides environment detection and adapts to browser,

View file

@ -6,7 +6,7 @@
[![Node.js](https://img.shields.io/badge/node-%3E%3D24.0.0-brightgreen.svg)](https://nodejs.org/)
[![TypeScript](https://img.shields.io/badge/TypeScript-5.1.6-blue.svg)](https://www.typescriptlang.org/)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
[![npm](https://img.shields.io/badge/npm-v0.9.13-blue.svg)](https://www.npmjs.com/package/@soulcraft/brainy)
[![npm](https://img.shields.io/badge/npm-v0.9.14-blue.svg)](https://www.npmjs.com/package/@soulcraft/brainy)
[//]: # ([![Cartographer](https://img.shields.io/badge/Cartographer-Official%20Standard-brightgreen)](https://github.com/sodal-project/cartographer))
@ -300,8 +300,8 @@ Brainy uses a modern build system that optimizes for both Node.js and browser en
5. **Build Scripts**
- `npm run build`: Builds the Node.js version
- `npm run build:browser`: Builds the browser-optimized version
- `npm run build:all`: Builds both versions
- `npm run demo`: Builds all versions and starts a demo server
- `npm run build:cli`: Builds the CLI version
- `npm run demo`: Builds both Node.js and browser versions and starts a demo server
- GitHub Actions workflow: Automatically deploys the demo directory to GitHub Pages when pushing to the main branch
### Running the Pipeline

View file

@ -85,9 +85,7 @@
"LICENSE",
"README.md",
"cli-wrapper.js",
"brainy.png",
"!dist/cli.js",
"!dist/cli.js.map"
"brainy.png"
],
"devDependencies": {
"@rollup/plugin-commonjs": "^25.0.7",

View file

@ -3,4 +3,4 @@
* Do not modify this file directly.
*/
export const VERSION = '0.9.13';
export const VERSION = '0.9.14';