@soulcraft/brainy 0.9.14 → 0.9.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.demo.md +9 -3
- package/README.md +3 -3
- package/dist/cli.js +169296 -0
- package/dist/utils/distance-js.d.ts +38 -0
- package/dist/utils/distance-wasm.d.ts +36 -0
- package/dist/utils/version.d.ts +1 -1
- package/package.json +3 -4
package/README.demo.md
CHANGED
|
@@ -4,8 +4,8 @@ The Brainy interactive demo showcases the library's features in a web browser. F
|
|
|
4
4
|
|
|
5
5
|
## Prerequisites
|
|
6
6
|
|
|
7
|
-
- Make sure you have Node.js installed (version
|
|
8
|
-
- Ensure the project is built (`npm run build:
|
|
7
|
+
- Make sure you have Node.js installed (version 24.0.0 or higher)
|
|
8
|
+
- Ensure the project is built (run both `npm run build` and `npm run build:browser`)
|
|
9
9
|
|
|
10
10
|
## Running the Demo
|
|
11
11
|
|
|
@@ -51,7 +51,13 @@ The Brainy library uses a two-step build process:
|
|
|
51
51
|
You can run both steps together with:
|
|
52
52
|
|
|
53
53
|
```bash
|
|
54
|
-
npm run build:
|
|
54
|
+
npm run build && npm run build:browser
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Or simply use the demo script which does this for you:
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
npm run demo
|
|
55
61
|
```
|
|
56
62
|
|
|
57
63
|
The browser bundle is created from `src/unified.ts`, which provides environment detection and adapts to browser,
|
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
[](https://nodejs.org/)
|
|
7
7
|
[](https://www.typescriptlang.org/)
|
|
8
8
|
[](CONTRIBUTING.md)
|
|
9
|
-
[](https://www.npmjs.com/package/@soulcraft/brainy)
|
|
10
10
|
|
|
11
11
|
[//]: # ([](https://github.com/sodal-project/cartographer))
|
|
12
12
|
|
|
@@ -300,8 +300,8 @@ Brainy uses a modern build system that optimizes for both Node.js and browser en
|
|
|
300
300
|
5. **Build Scripts**
|
|
301
301
|
- `npm run build`: Builds the Node.js version
|
|
302
302
|
- `npm run build:browser`: Builds the browser-optimized version
|
|
303
|
-
- `npm run build:
|
|
304
|
-
- `npm run demo`: Builds
|
|
303
|
+
- `npm run build:cli`: Builds the CLI version
|
|
304
|
+
- `npm run demo`: Builds both Node.js and browser versions and starts a demo server
|
|
305
305
|
- GitHub Actions workflow: Automatically deploys the demo directory to GitHub Pages when pushing to the main branch
|
|
306
306
|
|
|
307
307
|
### Running the Pipeline
|