From d203baaf35512c108028c1b4783c9d0121da26cd Mon Sep 17 00:00:00 2001 From: msqr1 Date: Fri, 19 Jul 2024 14:17:43 -0700 Subject: [PATCH] Make notice even more visible --- README.md | 2 +- examples/README.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 examples/README.md diff --git a/README.md b/README.md index 613d506..4469f65 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ - See the *examples* folder for examples on using the API. - See *API.md* for the API reference - See *test* for a developer build script for just the JS -- Note: The examples uses *examples/Vosklet.js* because I can't set the Response headers for my model for browsers to decompress correctly. Instead, I used DecompressionStream to decompress manually, so *examples/Vosklet.js* only works for the examples. In practice, please use the outside Vosklet.js instead. # Compared to vosk-browser - Support multiple models @@ -19,6 +18,7 @@ # Basic usage (microphone recognition in English) - Result are logged to the console. - Copied from *examples/fromMic.html* +- **Note: The example folder and this piece of code uses *examples/Vosklet.js* because I can't set the Response headers for my model for browsers to decompress correctly. Instead, I used DecompressionStream to decompress manually, so *examples/Vosklet.js* only works for the examples. In production, please use the top-level Vosklet.js instead.** ```html diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..115f7d7 --- /dev/null +++ b/examples/README.md @@ -0,0 +1 @@ +**Note: Examples in this folder uses its own *Vosklet.js* because I can't set the Response headers for my model for browsers to decompress correctly. Instead, I used DecompressionStream to decompress manually, so this *Vosklet.js* only works for the examples. In production, please use the top-level Vosklet.js instead.** \ No newline at end of file