update indications.

Author: Carlos Antonio Mata Meza

README.md

@@ -1,6 +1,11 @@
 # Teotl
-## API for recognition facial
-> python: version 3.6
+## API for recognition and comparation facial
+### Introduction
+> rest api service to detect faces, with the ability to detect similarities in two images with faces
+## Create with
+* python: version 3.6
+* Flask 1.1.2
+* face-recognition 1.3.0
 ## Installation
 
 * python3 -m venv ./venv
@@ -11,12 +16,19 @@
 
 ## Functions
 
-> /compareFaces [POST]
-* compare two images to find facial similarities (with format Base64 JSON)
+> **/compareFaces** [POST]
+>> compare two images to find facial similarities (with format Base64 JSON)
+>> ### Parameters
+>> * user_profile_picture : base 64 encode string of person
+>> * user_webcam_photo : base 64 encode string imagen to compare
 
-> /compareFacesPath [POST]
-* compare two images to find facial similarities (with format Path request file)
+> **/compareFacesPath** [POST]
+>> compare two images to find facial similarities (with format Path request file)
+>> ### Parameters
+>> * user_profile_picture : file of person
+>> * user_webcam_photo : file imagen to compare
 
-> /detectFaces [POST]
-* analyzes an image to detect faces (with format Path request file)
-                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                
+> **/detectFaces** [POST]
+>> analyzes an image to detect faces (with format Path request file)
+>> ### Parameters
+>> * profile_picture : file imagen to search faces