From ff173ce2043755ea9efd302caa856f360e12e7ee Mon Sep 17 00:00:00 2001 From: Balearica Date: Wed, 13 Sep 2023 17:53:58 -0700 Subject: [PATCH] Update api.md --- docs/api.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/api.md b/docs/api.md index 2129a4c84..f5b64a185 100644 --- a/docs/api.md +++ b/docs/api.md @@ -32,7 +32,8 @@ createWorker is a factory function that creates a tesseract worker, a worker is **Arguments:** - `options` an object of customized options - - `corePath` path for tesseract-core.js script + - `corePath` path to a directory containing **both** `tesseract-core.wasm.js` and `tesseract-core-simd.wasm.js` from [Tesseract.js-core](https://www.npmjs.com/package/tesseract.js-core) package + - Setting `corePath` to a specific `.js` file is **strongly discouraged.** To provide the best performance on all devices, Tesseract.js needs to be able to pick between `tesseract-core.wasm.js` and `tesseract-core-simd.wasm.js`. See [this issue](https://github.com/naptha/tesseract.js/issues/735) for more detail. - `langPath` path for downloading traineddata, do not include `/` at the end of the path - `workerPath` path for downloading worker script - `dataPath` path for saving traineddata in WebAssembly file system, not common to modify