Add readme file for image redactor (#545)

presidio-anonymizer/README.MD

@@ -101,21 +101,15 @@ print(result)
 
 ```
 
-### As service:
+### As docker service:
 
 In folder presidio/presidio-anonymizer run:
 
 ```
-pipenv sync
+docker-compose up -d
 ```
 
-Start the server with flask (**_this is a test server please do not use in prod_**):
-
-```
-pipenv run app.py
-```
-
-The request should be:
+### HTTP API
 
 ```
 POST /anonymize
@@ -170,7 +164,7 @@ Result:
 hello world, my name is <NAME>. My number is: 03445****
 ```
 
-### HTTP API
+
 
 #### /anonymizers
 

presidio-image-redactor/README.MD

@@ -1,18 +1,106 @@
 # Presidio Image Redactor
 
+***Please notice, this package is still in alpha and not production ready.***
+
 ## Description
 
-The Presidio Image Redactor is a Python based module for detecting and redacting PII text
-entities in images.
+The Presidio Image Redactor is a Python based module for detecting and redacting PII
+text entities in images.
+![img.png](img.png)
 
-## Usage
+## Installation
 
 Pre-requisites:
 
--   Install [Tesseract OCR](https://github.com/tesseract-ocr/tesseract) by following the instructions on how to install it for your operating system. The Image-Redactor was tested with a minimal version of 4.0.0
--   Install [Spacy model](https://spacy.io/usage/models) to use with the presidio-analyzer.
+- Install [Tesseract OCR](https://github.com/tesseract-ocr/tesseract) by following the
+  instructions on how to install it for your operating system.
+
+  The Image-Redactor was tested with a minimal version of 4.0.0
+
+### As package:
+
+To get started with Presidio-image-redactor, run the following:
+
+```sh
+pip install presidio-image-redactor
+```
+
+Once Installed, run the following command to download the default spacy model needed for
+Presidio Analyzer:
 
 ```sh
 python -m spacy download en_core_web_lg
+```
+
+## Getting started
+
+The engine will receive 2 parameters:
+
+1. Image to redact.
+2. Color fill to redact with, by default color fill will be black. Can either be an int
+   or tuple (0,0,0)
+
+```python
+from PIL import Image
+from presidio_image_redactor import ImageRedactorEngine
+
+# Get the image to redact using PIL lib (pillow)
+image = Image.open("ocr_text.png")
+
+# Initialize the engine
+engine = ImageRedactorEngine()
+
+# Redact the image with pink color
+redacted_image = engine.redact(image, (255, 192, 203))
+
+# save the redacted image 
+redacted_image.save("new_image.png")
+# open the image for viewing
+redacted_image.show()
+```
+
+### As docker service:
+
+In folder presidio/presidio-image-redactor run:
 
 ```
+docker-compose up -d
+```
+
+### HTTP API
+
+### redact
+
+Receives an image and color fill (optional, default is black). Redact the image PII text
+and returns a new redacted image.
+
+```
+POST /redact
+```
+
+Payload:
+
+Sent as multipart-form. Contains image file and data of the required color fill.
+
+```json
+{
+  "data": "{'color_fill':'0,0,0'}"
+}
+```
+
+Result:
+
+```
+200 OK
+```
+
+curl example:
+
+```
+# use ocr_test.png as the image to redact, and 255 as the color fill. 
+# out.png is the new redacted image received from the server.
+curl -XPOST "http://localhost:3000/anonymize" -H "content-type: multipart/form-data" -F "image=@ocr_test.png" -F "data=\"{'color_fill':'255'}\"" > out.png
+```
+
+Python script example can be found under:
+/presidio/e2e-tests/tests/test_image_redactor.py