add note about lang instead of options

master
Guillermo 8 years ago
parent e5c8df3aac
commit e8a286988f
  1. 2
      README.md

@ -83,7 +83,7 @@ You can [head to the docs](#docs) for a full treatment of the API.
## Tesseract.recognize(image: [ImageLike](#imagelike)[, options]) -> [TesseractJob](#tesseractjob)
Figures out what words are in `image`, where the words are in `image`, etc.
- `image` is any [ImageLike](#imagelike) object.
- `options` is an optional flat json object. `options` may:
- `options` is either absent, a string specifing a language short code from the [language list](./tesseract_lang_list.md), or a flat json object that may:
+ include properties that override some subset of the [default tesseract parameters](./tesseract_parameters.md)
+ include a `lang` property with a value from the [list of lang parameters](./tesseract_lang_list.md)

Loading…
Cancel
Save