Merge pull request #2282 from Dexterp37/update_docs

reuben · web-flow · commit 4c6620fec954 · 2022-08-10T18:40:13.000+02:00
Add the wasm docs
diff --git a/doc/DEPLOYMENT.rst b/doc/DEPLOYMENT.rst
@@ -17,6 +17,7 @@ You can deploy 🐸STT models either via a command-line client or a language bin
 * :ref:`The Android libstt AAR package <android-usage>`
 * :ref:`The command-line client <cli-usage>`
 * :ref:`The C API <c-usage>`
+* :ref:`Using the WebAssembly package <wasm-usage>`
 
 In some use cases, you might want to use the inference facilities built into the training code, for example for faster prototyping of new features. They are not production-ready, but because it's all Python code you won't need to recompile in order to test code changes, which can be much faster. See :ref:`checkpoint-inference` for more details.
 
@@ -177,6 +178,23 @@ Alongside the pre-built binaries for the ``stt`` command-line client described :
 
 Then, simply include the header file and link against the shared libraries in your project, and you should be able to use the C API. Reference documentation is available in :ref:`c-api`.
 
+.. _wasm-usage:
+
+Using the WebAssembly package
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+A pre-built ES5 libstt WebAssembly package can be `downloaded from GitHub Releases <https://github.com/coqui-ai/STT/releases/latest/download/libstt.tflite.wasm.zip>`_ .
+See the `wasm` directory in `STT-examples <https://github.com/coqui-ai/STT-examples/>_` for an example of how to use the package programmatically in a web page.
+
+A pre-built ES6 libstt WebAssembly package can be downloaded using `npm`:
+
+
+.. code-block:: bash
+
+   npm install stt-wasm
+
+The ES6 package can be used in projects using bundlers.
+
 Installing bindings from source
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
diff --git a/doc/NodeJS-API.rst b/doc/NodeJS-API.rst
@@ -1,4 +1,4 @@
-JavaScript (NodeJS / ElectronJS)
+JavaScript (NodeJS / ElectronJS / WASM)
 ================================
 
 Model

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-JavaScript (NodeJS / ElectronJS)`
	`1`	`+JavaScript (NodeJS / ElectronJS / WASM)`
`2`	`2`	`================================`
`3`	`3`
`4`	`4`	`Model`