From 84f74048f1b30d7bc13362c2473e1f7388c7b59d Mon Sep 17 00:00:00 2001 From: David Snelling Date: Wed, 2 Jul 2025 10:20:58 -0700 Subject: [PATCH] **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. --- README.demo.md | 12 +++++++++--- README.md | 6 +++--- package.json | 4 +--- src/utils/version.ts | 2 +- 4 files changed, 14 insertions(+), 10 deletions(-) diff --git a/README.demo.md b/README.demo.md index 9a706bb8..9bdd2272 100644 --- a/README.demo.md +++ b/README.demo.md @@ -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, diff --git a/README.md b/README.md index 126ae679..9b88b6a7 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/package.json b/package.json index b773e625..91cedf76 100644 --- a/package.json +++ b/package.json @@ -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", diff --git a/src/utils/version.ts b/src/utils/version.ts index d0858f28..f9d77c6d 100644 --- a/src/utils/version.ts +++ b/src/utils/version.ts @@ -3,4 +3,4 @@ * Do not modify this file directly. */ -export const VERSION = '0.9.13'; +export const VERSION = '0.9.14';