diff --git a/README.md b/README.md index 43f5422..90c8b9c 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ [![Downloads Total](https://img.shields.io/npm/dt/tesseract.js.svg)](https://www.npmjs.com/package/tesseract.js) [![Downloads Month](https://img.shields.io/npm/dm/tesseract.js.svg)](https://www.npmjs.com/package/tesseract.js) -**Tessearct.js v2 is now available and under development in master branch, check [support/1.x](https://github.com/naptha/tesseract.js/tree/support/1.x) branch for v1.** +**Tesseract.js v2 is now available and under development in master branch, check [support/1.x](https://github.com/naptha/tesseract.js/tree/support/1.x) branch for v1.** Tesseract.js is a javascript library that gets words in [almost any language](./docs/tesseract_lang_list.md) out of images. ([Demo](http://tesseract.projectnaptha.com/)) diff --git a/docs/api.md b/docs/api.md index 39a8cba..b95d6c9 100644 --- a/docs/api.md +++ b/docs/api.md @@ -13,7 +13,7 @@ Returns a [TesseractJob](#tesseractjob) whose `then`, `progress`, `catch` and `f ### Simple Example: ```javascript -const worker = new Tessearct.TesseractWorker(); +const worker = new Tesseract.TesseractWorker(); worker .recognize(myImage) .then(function(result){ @@ -23,7 +23,7 @@ worker ### More Complicated Example: ```javascript -const worker = new Tessearct.TesseractWorker(); +const worker = new Tesseract.TesseractWorker(); // if we know our image is of spanish words without the letter 'e': worker .recognize(myImage, 'spa', { @@ -43,7 +43,7 @@ Figures out what script (e.g. 'Latin', 'Chinese') the words in image are writte Returns a [TesseractJob](#tesseractjob) whose `then`, `progress`, `catch` and `finally` methods can be used to act on the result of the script. ```javascript -const worker = new Tessearct.TesseractWorker(); +const worker = new Tesseract.TesseractWorker(); worker .detect(myImage) .then(function(result){ @@ -57,7 +57,7 @@ A TesseractJob is an object returned by a call to `recognize` or `detect`. It's Typical use is: ```javascript -const worker = new Tessearct.TesseractWorker(); +const worker = new Tesseract.TesseractWorker(); worker.recognize(myImage) .progress(message => console.log(message)) .catch(err => console.error(err)) @@ -67,7 +67,7 @@ worker.recognize(myImage) Which is equivalent to: ```javascript -const worker = new Tessearct.TesseractWorker(); +const worker = new Tesseract.TesseractWorker(); const job1 = worker.recognize(myImage); job1.progress(message => console.log(message)); @@ -87,7 +87,7 @@ Sets `callback` as the function that will be called every time the job progresse For example: ```javascript -const worker = new Tessearct.TesseractWorker(); +const worker = new Tesseract.TesseractWorker(); worker.recognize(myImage) .progress(function(message){console.log('progress is: ', message)}); ``` @@ -113,7 +113,7 @@ Sets `callback` as the function that will be called if and when the job successf For example: ```javascript -const worker = new Tessearct.TesseractWorker(); +const worker = new Tesseract.TesseractWorker(); worker.recognize(myImage) .then(function(result){console.log('result is: ', result)}); ``` diff --git a/docs/examples.md b/docs/examples.md index 1c9f280..733dafb 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -8,7 +8,7 @@ You can also check [examples](../examples) folder. import Tesseract from 'tesseract.js'; const { TesseractWorker } = Tesseract; -const worker = new TessearctWorker(); +const worker = new TesseractWorker(); worker .recognize('http://jeroen.github.io/images/testocr.png') @@ -23,7 +23,7 @@ worker import Tesseract from 'tesseract.js'; const { TesseractWorker } = Tesseract; -const worker = new TessearctWorker(); +const worker = new TesseractWorker(); worker .recognize('http://jeroen.github.io/images/testocr.png') @@ -41,7 +41,7 @@ worker import Tesseract from 'tesseract.js'; const { TesseractWorker } = Tesseract; -const worker = new TessearctWorker(); +const worker = new TesseractWorker(); worker .recognize( diff --git a/docs/local-installation.md b/docs/local-installation.md index c554d22..a3a17f1 100644 --- a/docs/local-installation.md +++ b/docs/local-installation.md @@ -4,7 +4,7 @@ Check here for an example: https://github.com/jeromewu/tesseract.js-offline In browser environment, `tesseract.js` simply provides the API layer. Internally, it opens a WebWorker to handle requests. That worker itself loads code from the Emscripten-built `tesseract.js-core` which itself is hosted on a CDN. Then it dynamically loads language files hosted on another CDN. -Because of this we recommend loading `tesseract.js` from a CDN. But if you really need to have all your files local, you can pass extra arguments to `TessearctWorker` to specify custom paths for workers, languages, and core. +Because of this we recommend loading `tesseract.js` from a CDN. But if you really need to have all your files local, you can pass extra arguments to `TesseractWorker` to specify custom paths for workers, languages, and core. In Node.js environment, the only path you may want to customize is languages/langPath.