Skip to content

Commit b9e6383

Browse files
authored
Update README.md
1 parent cc9ab08 commit b9e6383

1 file changed

Lines changed: 13 additions & 10 deletions

File tree

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ QuickCapture Mobile Scanning SDK Specially designed for native ANDROID from [Ext
77

88
> It's not "**just**" a scanning SDK. It's a "**document**" scanning/capture SDK evolved with **Best Quality**, **Highest Possible Compression**, **Image Optimisation**, of output document in mind.
99
10-
> Control **DPI**,**Layout** & **Size** of output images, PDF & TIFF
10+
> Controls **DPI**,**Layout** & **Size** of output images, PDF & TIFF
1111
1212
> **QR code** & **BAR Code** Scanning & Generation
1313
@@ -62,7 +62,7 @@ Or Maven:
6262
</dependency>
6363
```
6464

65-
Or even you can download the **.aar** library file from GitHub's [releases page](https://github.com/ExtrieveTechnologies/QuickCapture_Android/releases/) and add the file dependency manually in to the project/app.
65+
Or you can even download the **.aar** library file from GitHub's [releases page](https://github.com/ExtrieveTechnologies/QuickCapture_Android/releases/) and add the file dependency manually in to the project/app.
6666

6767

6868
Compatibility
@@ -76,13 +76,13 @@ Compatibility
7676

7777
SDK have two core classes and supporting classes :
7878

79-
1. **CameraHelper** - *Handle the camera related operations. Basically, an activity.*
79+
1. **CameraHelper** - *Handles the camera related operations. Basically, an activity.*
8080
2. **ImgHelper** - *Purpose of this class is to handle all imaging related operations.*
81-
3. **OpticalCodeHelper** - *Handle the Opticalcode (QR CODE & BAR CODE) related activities*
81+
3. **OpticalCodeHelper** - *Handles the Opticalcode (QR CODE & BAR CODE) related activities*
8282
4. **Config** - *Holds various configurations for SDK.*
8383

8484

85-
Based on the requirement, any one or all classes can be used.And need to import those from the SDK.
85+
Based on the requirement, any or all classes can be used. These classes need to be imported from the SDK.
8686
```java
8787
import com.extrieve.quickcapture.sdk.*;
8888
//OR : can import only required classes as per use cases.
@@ -113,7 +113,7 @@ SDK having multiple flows as follows :
113113
* **IMAGE_ATTACH_REVIEW** - *Attach/pass image **->** review.*
114114

115115

116-
**1. CAMERA_CAPTURE_REVIEW** - *Default flow of the CameraHelper.Includes Capture with SDK Camera -> Review Image.*
116+
**1. CAMERA_CAPTURE_REVIEW** - *Default flow of the CameraHelper. Includes Capture with SDK Camera -> Review Image.*
117117

118118
```java
119119
//JAVA
@@ -229,7 +229,7 @@ try {
229229
}
230230
```
231231

232-
**3. IMAGE_ATTACH_REVIEW** - *If user need to review an image from device / gallery - this option can be used.After attach each image,review and all functionalities depends on review can be avail*.
232+
**3. IMAGE_ATTACH_REVIEW** - *If user needs to review an image from device / gallery - this option can be used. After attaching an image,review and all functionalities depends on review can be avail*.
233233

234234
```java
235235
//JAVA
@@ -285,7 +285,9 @@ try {
285285
}
286286
```
287287
## Config
288-
SDK included a supporting class with static configuration - which includes all configurations related to SDK.Confg contains a sub configuration collection **CaptureSupport** - contains all the Capture & review related configurations.
288+
SDK is included with a supporting class that has static configuration - this includes all configurations related to SDK.Config contains a collection of sub configurations which include:
289+
290+
- **CaptureSupport** - contains all the Capture & review related configurations.
289291
Config.CaptureSupport : contains various configurations as follows:
290292

291293
- **OutputPath** - To set the output directory in which the captured images will be saved.Base app should have rights to write to the provided path.
@@ -327,7 +329,7 @@ Config.CaptureSupport : contains various configurations as follows:
327329
//RBG (1) - Use capture flow in color mode.
328330
//GREY (2) - Use capture flow in grey scale mode.
329331
```
330-
- **EnableFlash** - Enable Document capture specific flash control for SDK camera.
332+
- **EnableFlash** - Enable Document capture specific to flash control for SDK camera.
331333
```java
332334
//JAVA
333335
Config.CaptureSupport.EnableFlash = true;
@@ -360,6 +362,7 @@ Config.CaptureSupport : contains various configurations as follows:
360362
//DISABLED (0) -Disable camera toggle option.
361363
//ENABLE_BACK_DEFAULT (1) - Enable camera toggle option with Front camera by default.
362364
//ENABLE_FRONT_DEFAULT (2) - Enable camera toggle option with Back camera by default.
365+
363366
**Common** - contains all the Capture & review related configurations.
364367
Config.CaptureSupport : contains various configurations as follows:
365368
- **SDKInfo** - Contains all version related information on SDK.
@@ -409,7 +412,7 @@ ImgHelper ImageHelper = new ImgHelper(this);
409412
//Kotlin
410413
var ImageHelper: ImgHelper? = ImgHelper(this)
411414
```
412-
- ***SetImageQuality*** - *Set the Quality of the image, Document_Qualityisused.If documents are used further for any automations and OCR, use Document_Quality.*
415+
- ***SetImageQuality*** - *Set the Quality of the image, Document_Quality is used. If documents are used further for any automations and OCR, use Document_Quality.*
413416
>*Available Image Qualities* :
414417
1. Photo_Quality.
415418
2. Document_Quality.

0 commit comments

Comments
 (0)