You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
193 lines
8.7 KiB
193 lines
8.7 KiB
<p align="center">
|
|
<a href="https://tesseract.projectnaptha.com/"><img width="256px" height="256px" alt="Tesseract.js" src="./docs/images/tesseract.png"></a>
|
|
</p>
|
|
|
|
|
|
|
|
[](https://github.com/naptha/tesseract.js)
|
|
[](https://opencollective.com/tesseractjs) [](https://badge.fury.io/js/tesseract.js)
|
|
[](https://github.com/naptha/tesseract.js/graphs/commit-activity)
|
|
[](https://opensource.org/licenses/Apache-2.0)
|
|
[](https://github.com/airbnb/javascript)
|
|
[](https://www.npmjs.com/package/tesseract.js)
|
|
[](https://www.npmjs.com/package/tesseract.js)
|
|
|
|
<h3 align="center">
|
|
Version 2 is now available and under development in the master branch, read a story about v2: <a href="https://jeromewu.github.io/why-i-refactor-tesseract.js-v2/">Why I refactor tesseract.js v2?</a><br>
|
|
Check the <a href="https://github.com/naptha/tesseract.js/tree/support/1.x">support/1.x</a> branch for version 1
|
|
</h3>
|
|
|
|
<br>
|
|
|
|
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/))
|
|
|
|
Image Recognition
|
|
|
|
[](http://tesseract.projectnaptha.com)
|
|
|
|
Video Real-time Recognition
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/jeromewu/tesseract.js-video"><img alt="Tesseract.js Video" src="./docs/images/video-demo.gif"></a>
|
|
</p>
|
|
|
|
|
|
Tesseract.js wraps an [emscripten](https://github.com/kripken/emscripten) [port](https://github.com/naptha/tesseract.js-core) of the [Tesseract](https://github.com/tesseract-ocr/tesseract) [OCR](https://en.wikipedia.org/wiki/Optical_character_recognition) Engine.
|
|
It works in the browser using [webpack](https://webpack.js.org/) or plain script tags with a [CDN](#CDN) and on the server with [Node.js](https://nodejs.org/en/).
|
|
After you [install it](#installation), using it is as simple as:
|
|
|
|
```javascript
|
|
import Tesseract from 'tesseract.js';
|
|
|
|
Tesseract.recognize(
|
|
'https://tesseract.projectnaptha.com/img/eng_bw.png',
|
|
'eng',
|
|
{ logger: m => console.log(m) }
|
|
).then(({ data: { text } }) => {
|
|
console.log(text);
|
|
})
|
|
```
|
|
|
|
Or more imperative
|
|
|
|
```javascript
|
|
import { createWorker } from 'tesseract.js';
|
|
|
|
const worker = createWorker({
|
|
logger: m => console.log(m)
|
|
});
|
|
|
|
(async () => {
|
|
await worker.load();
|
|
await worker.loadLanguage('eng');
|
|
await worker.initialize('eng');
|
|
const { data: { text } } = await worker.recognize('https://tesseract.projectnaptha.com/img/eng_bw.png');
|
|
console.log(text);
|
|
await worker.terminate();
|
|
})();
|
|
```
|
|
|
|
[Check out the docs](#documentation) for a full explanation of the API.
|
|
|
|
|
|
## Major changes in v2
|
|
- Upgrade to tesseract v4.1.1 (using emscripten 1.39.10 upstream)
|
|
- Support multiple languages at the same time, eg: eng+chi\_tra for English and Traditional Chinese
|
|
- Supported image formats: png, jpg, bmp, pbm
|
|
- Support WebAssembly (fallback to ASM.js when browser doesn't support)
|
|
- Support Typescript
|
|
|
|
|
|
## Installation
|
|
Tesseract.js works with a `<script>` tag via local copy or CDN, with webpack via `npm` and on Node.js with `npm/yarn`.
|
|
|
|
|
|
### CDN
|
|
```html
|
|
<!-- v2 -->
|
|
<script src='https://unpkg.com/tesseract.js@v2.1.0/dist/tesseract.min.js'></script>
|
|
|
|
<!-- v1 -->
|
|
<script src='https://unpkg.com/tesseract.js@1.0.19/src/index.js'></script>
|
|
```
|
|
After including the script the `Tesseract` variable will be globally available.
|
|
|
|
|
|
### Node.js
|
|
|
|
**Tesseract.js currently requires Node.js v6.8.0 or higher**
|
|
|
|
```shell
|
|
# For v2
|
|
npm install tesseract.js
|
|
yarn add tesseract.js
|
|
|
|
# For v1
|
|
npm install tesseract.js@1
|
|
yarn add tesseract.js@1
|
|
```
|
|
|
|
|
|
## Documentation
|
|
|
|
* [Examples](./docs/examples.md)
|
|
* [Image Format](./docs/image-format.md)
|
|
* [API](./docs/api.md)
|
|
* [Local Installation](./docs/local-installation.md)
|
|
* [FAQ](./docs/faq.md)
|
|
|
|
## Use tesseract.js the way you like!
|
|
|
|
- Offline Version: https://github.com/jeromewu/tesseract.js-offline
|
|
- Electron Version: https://github.com/jeromewu/tesseract.js-electron
|
|
- Custom Traineddata: https://github.com/jeromewu/tesseract.js-custom-traineddata
|
|
- Chrome Extension #1: https://github.com/jeromewu/tesseract.js-chrome-extension
|
|
- Chrome Extension #2: https://github.com/fxnoob/image-to-text
|
|
- Firefox Extension: https://github.com/gnonio/korporize
|
|
- With Vue: https://github.com/jeromewu/tesseract.js-vue-app
|
|
- With Angular: https://github.com/jeromewu/tesseract.js-angular-app
|
|
- With React: https://github.com/jeromewu/tesseract.js-react-app
|
|
- Typescript: https://github.com/jeromewu/tesseract.js-typescript
|
|
- Video Real-time Recognition: https://github.com/jeromewu/tesseract.js-video
|
|
|
|
## Contributing
|
|
|
|
### Development
|
|
To run a development copy of Tesseract.js do the following:
|
|
```shell
|
|
# First we clone the repository
|
|
git clone https://github.com/naptha/tesseract.js.git
|
|
cd tesseract.js
|
|
|
|
# Then we install the dependencies
|
|
npm install
|
|
|
|
# And finally we start the development server
|
|
npm start
|
|
```
|
|
|
|
The development server will be available at http://localhost:3000/examples/browser/demo.html in your favorite browser.
|
|
It will automatically rebuild `tesseract.dev.js` and `worker.dev.js` when you change files in the **src** folder.
|
|
|
|
### Online Setup with a single Click
|
|
|
|
You can use Gitpod(A free online VS Code like IDE) for contributing. With a single click it will launch a ready to code workspace with the build & start scripts already in process and within a few seconds it will spin up the dev server so that you can start contributing straight away without wasting any time.
|
|
|
|
[](https://gitpod.io/#https://github.com/naptha/tesseract.js/blob/master/examples/browser/demo.html)
|
|
|
|
### Building Static Files
|
|
To build the compiled static files just execute the following:
|
|
```shell
|
|
npm run build
|
|
```
|
|
This will output the files into the `dist` directory.
|
|
|
|
## Contributors
|
|
|
|
### Code Contributors
|
|
|
|
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
|
|
<a href="https://github.com/naptha/tesseract.js/graphs/contributors"><img src="https://opencollective.com/tesseractjs/contributors.svg?width=890&button=false" /></a>
|
|
|
|
### Financial Contributors
|
|
|
|
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/tesseractjs/contribute)]
|
|
|
|
#### Individuals
|
|
|
|
<a href="https://opencollective.com/tesseractjs"><img src="https://opencollective.com/tesseractjs/individuals.svg?width=890"></a>
|
|
|
|
#### Organizations
|
|
|
|
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/tesseractjs/contribute)]
|
|
|
|
<a href="https://opencollective.com/tesseractjs/organization/0/website"><img src="https://opencollective.com/tesseractjs/organization/0/avatar.svg"></a>
|
|
<a href="https://opencollective.com/tesseractjs/organization/1/website"><img src="https://opencollective.com/tesseractjs/organization/1/avatar.svg"></a>
|
|
<a href="https://opencollective.com/tesseractjs/organization/2/website"><img src="https://opencollective.com/tesseractjs/organization/2/avatar.svg"></a>
|
|
<a href="https://opencollective.com/tesseractjs/organization/3/website"><img src="https://opencollective.com/tesseractjs/organization/3/avatar.svg"></a>
|
|
<a href="https://opencollective.com/tesseractjs/organization/4/website"><img src="https://opencollective.com/tesseractjs/organization/4/avatar.svg"></a>
|
|
<a href="https://opencollective.com/tesseractjs/organization/5/website"><img src="https://opencollective.com/tesseractjs/organization/5/avatar.svg"></a>
|
|
<a href="https://opencollective.com/tesseractjs/organization/6/website"><img src="https://opencollective.com/tesseractjs/organization/6/avatar.svg"></a>
|
|
<a href="https://opencollective.com/tesseractjs/organization/7/website"><img src="https://opencollective.com/tesseractjs/organization/7/avatar.svg"></a>
|
|
<a href="https://opencollective.com/tesseractjs/organization/8/website"><img src="https://opencollective.com/tesseractjs/organization/8/avatar.svg"></a>
|
|
<a href="https://opencollective.com/tesseractjs/organization/9/website"><img src="https://opencollective.com/tesseractjs/organization/9/avatar.svg"></a>
|
|
|