diff --git a/README.md b/README.md index 8018db03..5de7cc57 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,26 @@ # LiveEdgeDetection -LiveEdgeDetection is an Android document detection library. It scans documents from camera live mode and allows you to adjust crop using the selected 4 edges and performs perspective transformation of the cropped image. +LiveEdgeDetection is an Android document detection library built on top of openCV. It scans documents from camera live mode and allows you to adjust crop using the selected 4 edges and performs perspective transformation of the cropped image. + +It works best with a dark background. + +# Docs + +[JavaDoc](https://adityaarora1.github.io/LiveEdgeDetection/docs) + +# Download apk +Try the [sample app](https://drive.google.com/file/d/1sO26O4-1-2XAX16czREx7SiiCD8-4ecU/view?usp=sharing) + +# Screenshots + +![Use darker bg](https://github.com/adityaarora1/LiveEdgeDetection/blob/master/use_darker_bg.png) +![Move closer](https://github.com/adityaarora1/LiveEdgeDetection/blob/master/move_closer.png) +![Move away](https://github.com/adityaarora1/LiveEdgeDetection/blob/master/move_away.png) +![Adjust angle](https://github.com/adityaarora1/LiveEdgeDetection/blob/master/adjust_angle.png) +![Hold still](https://github.com/adityaarora1/LiveEdgeDetection/blob/master/hold_still.png) +![Adjust crop](https://github.com/adityaarora1/LiveEdgeDetection/blob/master/adjust_crop.png) +![Result](https://github.com/adityaarora1/LiveEdgeDetection/blob/master/cropped.png) # Integrating into your project This library is available in [JitPack.io](https://jitpack.io/) repository. @@ -41,3 +60,10 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ``` + +# Donation + +[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/adityaarora1) [![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.me/adityaarora1) + +![Paypal](https://github.com/adityaarora1/LiveEdgeDetection/blob/master/paypal_qr.gif) + diff --git a/adjust_angle.png b/adjust_angle.png new file mode 100644 index 00000000..624348b1 Binary files /dev/null and b/adjust_angle.png differ diff --git a/adjust_crop.png b/adjust_crop.png new file mode 100644 index 00000000..9c77f5b5 Binary files /dev/null and b/adjust_crop.png differ diff --git a/cropped.png b/cropped.png new file mode 100644 index 00000000..3ad2aa89 Binary files /dev/null and b/cropped.png differ diff --git a/hold_still.png b/hold_still.png new file mode 100644 index 00000000..e91b884d Binary files /dev/null and b/hold_still.png differ diff --git a/move_away.png b/move_away.png new file mode 100644 index 00000000..56f53a3d Binary files /dev/null and b/move_away.png differ diff --git a/move_closer.png b/move_closer.png new file mode 100644 index 00000000..e656110e Binary files /dev/null and b/move_closer.png differ diff --git a/paypal_qr.gif b/paypal_qr.gif new file mode 100644 index 00000000..686ec882 Binary files /dev/null and b/paypal_qr.gif differ diff --git a/use_darker_bg.png b/use_darker_bg.png new file mode 100644 index 00000000..af570f99 Binary files /dev/null and b/use_darker_bg.png differ