Add README

dsjonline · May 31, 2020 · d631e56 · d631e56
1 parent 9edf45b
commit d631e56
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -47,5 +47,6 @@ nodejs/example/model
 nodejs/example/test.wav
 nodejs/node_modules
 nodejs/package-lock.json
+nodejs/build
 
 
diff --git a/nodejs/README.md b/nodejs/README.md
@@ -0,0 +1,20 @@
+Installation requires vosk-api checkout, it doesn't yet work with `npm
+install vosk`. We have to figure out how to properly distribute native
+modules for Vosk.
+
+The build tested with node-0.10.15, node-0.12 is not yet supported by swig.
+
+Still, you need swig of newest version 4.0.1
+
+Build like this
+
+```
+npm install --kaldi_root=/home/suser/kaldi
+```
+
+Then test with
+
+```
+cd example
+node test.js
+```
diff --git a/nodejs/package.json b/nodejs/package.json
@@ -1,6 +1,6 @@
 {
   "name": "vosk",
-  "version": "0.3.7",
+  "version": "0.3.8",
   "description": "Node binding for continuous voice recoginition through pocketsphinx.",
   "repository": {
     "type": "git",