From e8a286988f1e4c708d9ee20c34b5552a71b4e606 Mon Sep 17 00:00:00 2001 From: Guillermo Date: Tue, 11 Oct 2016 03:52:28 -0400 Subject: [PATCH] add note about lang instead of options --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 252dd71..19e5e9a 100644 --- a/README.md +++ b/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)