From 80cf96fc2a3885bf7f4f0650f2d62a8a3e15f5ad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Villeneuve?= Date: Wed, 19 Jul 2017 12:15:34 +0200 Subject: [PATCH] Update readme --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 45af6d7..99f0522 100644 --- a/README.md +++ b/README.md @@ -65,18 +65,18 @@ class YourComponent extends Component { | contrast | `1` | `float` | Increase or decrease camera contrast. Normal as default | ## Each rectangle detection -| Prop | Params | Type | Description | -| :------ | :------: | :--------:| :--------| -| onRectangleDetect | `{ stableCounter, lastDetectionType }` | `object` | See below | +| Props | Params | Type | Description | +|-------------------|----------------------------------------|----------|-------------| +| onRectangleDetect | `{ stableCounter, lastDetectionType }` | `object` | See below | The returned object includes the following keys : -`stableCounter` ---- +- `stableCounter` + Number of correctly formated rectangle found (this number triggers capture once it goes above `detectionCountBeforeCapture`) -`lastDetectionType` ---- +- `lastDetectionType` + Enum (0, 1 or 2) corresponding to the type of rectangle found 0. Correctly formated rectangle 1. Wrong perspective, bad angle @@ -86,7 +86,7 @@ Enum (0, 1 or 2) corresponding to the type of rectangle found ## Returned image | Prop | Params | Type | Description | -| :----------- | :-------: | :--------:| :----------| +| :----------- |:-------:| :--------:| :----------| | onPictureTaken | `data` | `object` | Returns the captured image in an object `{ image: 'BASE64 string'}` |