openwakeword-js 0.1.4 → 0.1.6

package/README.md

@@ -98,13 +98,19 @@ if (scores["my_custom_model"] > 0.5) {
 
 ## Local Development & Demo
 
-We have included a full working example in the `example/` folder.
-
-1.  Clone the repo and run `npm install`.
-2.  Run `npm run download-models`.
-3.  Serve the root directory using a static server (e.g., `npx serve .`).
-4.  Navigate to `http://localhost:3000/example/index.html`.
-5.  Allow Microphone access and watch the real-time scores.
+### Option A: The Fast Start (Automated)
+If you just want to see it working:
+1. `npm install openwakeword-js onnxruntime-web`
+2. `npx openwakeword-js-setup`
+3. `npx serve .` 
+4. Open `http://localhost:3000`
+
+### Option B: Manual Development
+If you are developing inside this repository:
+1. Clone the repo and run `npm install`.
+2. Run `npm run download-models`.
+3. Serve the root directory using a static server (e.g., `npx serve .`).
+4. Navigate to `http://localhost:3000/example/index.html`.
 
 ---
 

package/example/index.html

@@ -435,7 +435,7 @@
     <!-- Scripts -->
     <script src="https://cdn.jsdelivr.net/npm/onnxruntime-web/dist/ort.min.js"></script>
     <script type="module">
-        import { Model } from 'https://cdn.jsdelivr.net/npm/openwakeword-js/dist/index.mjs';
+        import { Model } from 'https://cdn.jsdelivr.net/npm/openwakeword-js@0.1.4/dist/index.mjs';
 
         const elements = {
             orb: document.getElementById('orbOuter'),

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "openwakeword-js",
-    "version": "0.1.4",
+    "version": "0.1.6",
     "description": "Port of openWakeWord to JavaScript/TypeScript using ONNX Runtime",
     "bin": {
         "openwakeword-js-setup": "scripts/download_models.js"

package/scripts/download_models.js

@@ -11,7 +11,9 @@ const MODELS_DIR = path.join(process.cwd(), 'models');
 const MODELS = {
     'melspectrogram.onnx': 'https://github.com/dscripka/openWakeWord/raw/main/openwakeword/resources/models/melspectrogram.onnx',
     'embedding_model.onnx': 'https://github.com/dscripka/openWakeWord/raw/main/openwakeword/resources/models/embedding_model.onnx',
-    'silero_vad.onnx': 'https://github.com/dscripka/openWakeWord/raw/main/openwakeword/resources/models/silero_vad.onnx'
+    'silero_vad.onnx': 'https://github.com/dscripka/openWakeWord/raw/main/openwakeword/resources/models/silero_vad.onnx',
+    'hello_deepa.onnx': 'https://github.com/Firojpaudel/OpenWakeWord_npm_porting/raw/main/models/hello_deepa.onnx',
+    'namaste_deepa.onnx': 'https://github.com/Firojpaudel/OpenWakeWord_npm_porting/raw/main/models/namaste_deepa.onnx'
 };
 
 async function downloadFile(url, dest) {
@@ -64,13 +66,7 @@ async function main() {
             console.log(`Failed: ${err.message}`);
         }
     }
-    console.log('\nDeploying sample wake word models...');
-    const packageModelsDir = path.join(packageRoot, 'models');
-    ['hello_deepa.onnx', 'namaste_deepa.onnx'].forEach(m => {
-        const src = path.join(packageModelsDir, m);
-        const dest = path.join(MODELS_DIR, m);
-        copyIfExists(src, dest, 'Model');
-    });
+    console.log('\nBase and sample models are ready.');
 
     console.log('\nLocating ONNX Runtime WebAssembly files...');
     const nodeModulesPath = path.join(process.cwd(), 'node_modules', 'onnxruntime-web', 'dist');