From 79081c6fb7023d9c57730eac4bc8657b9e573ebc Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?F=C3=A9lix=20Yriarte?= <felix.yriarte@gmail.com>
Date: Sun, 25 Sep 2022 20:34:08 +0000
Subject: [PATCH] updated Method in readMe

---
 README.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/README.md b/README.md
index 0a0d177..becd8c3 100644
--- a/README.md
+++ b/README.md
@@ -28,6 +28,7 @@ You can find here the [impementation](https://gitlab.liris.cnrs.fr/gdr_isis_fuzz
 
 # Method
 The implementation of our method was done using Python and standard image processing libraries, such as OpenCV, matplotlib, and scikit-image.
+To compare two document images, one can call the ***check***(*str* ***image1Path***, *str* ***image2Path***) function. The function will return two booleans, indicating if the match passed the two steps, and will also save images of both the distance map and distance dispersion map. 
 
 # Dataset
 The augmented PaySlip dataset can be downloaded [here](https://gitlab.liris.cnrs.fr/gdr_isis_fuzzydoc/fuzzydoc_paper1/-/tree/master/subset). We provide 100 document images printed and scanned using X priner/scanner at 600dpi resolution.
-- 
GitLab