openwakeword-js 0.1.4 → 0.1.5

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.
Files changed (2) hide show
  1. package/README.md +13 -7
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -98,13 +98,19 @@ if (scores["my_custom_model"] > 0.5) {
98
98
 
99
99
  ## Local Development & Demo
100
100
 
101
- We have included a full working example in the `example/` folder.
102
-
103
- 1. Clone the repo and run `npm install`.
104
- 2. Run `npm run download-models`.
105
- 3. Serve the root directory using a static server (e.g., `npx serve .`).
106
- 4. Navigate to `http://localhost:3000/example/index.html`.
107
- 5. Allow Microphone access and watch the real-time scores.
101
+ ### Option A: The Fast Start (Automated)
102
+ If you just want to see it working:
103
+ 1. `npm install openwakeword-js onnxruntime-web`
104
+ 2. `npx openwakeword-js-setup`
105
+ 3. `npx serve .`
106
+ 4. Open `http://localhost:3000`
107
+
108
+ ### Option B: Manual Development
109
+ If you are developing inside this repository:
110
+ 1. Clone the repo and run `npm install`.
111
+ 2. Run `npm run download-models`.
112
+ 3. Serve the root directory using a static server (e.g., `npx serve .`).
113
+ 4. Navigate to `http://localhost:3000/example/index.html`.
108
114
 
109
115
  ---
110
116
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "openwakeword-js",
3
- "version": "0.1.4",
3
+ "version": "0.1.5",
4
4
  "description": "Port of openWakeWord to JavaScript/TypeScript using ONNX Runtime",
5
5
  "bin": {
6
6
  "openwakeword-js-setup": "scripts/download_models.js"