chore(mlkit-face-detection): README update (#40)

Ombuweb · web-flow · commit 93c6d5d5c697 · 2023-05-11T09:06:54.000-07:00
diff --git a/packages/mlkit-face-detection/README.md b/packages/mlkit-face-detection/README.md
@@ -1,12 +1,66 @@
 # @nativescript/mlkit-face-detection
 
-```javascript
+A plugin that is used with [@nativescript/mlkit-core](../mlkit-core/) to enable face detection and provide the [FaceResult](#faceresult) type for the data of the face detection event.
+
+## Contents
+* [Installation](#installation)
+* [Use @nativescript/mlkit-face-detection](#use-nativescriptmlkit-face-detection)
+* [API](#api)
+    * [FaceResult](#faceresult)
+* [License](#license)
+
+## Installation
+Install `@nativescript/mlkit-face-detection` by running the following command:
+
+```cli
 npm install @nativescript/mlkit-face-detection
 ```
 
-## Usage
+## Use @nativescript/mlkit-face-detection
+
+For more details, read [use @nativescript/mlkit-core](../mlkit-core#use-nativescriptmlkit-core) and [@nativescript/mlkit-core](../mlkit-core#face-detection)
+
+## API
+
+### FaceResult
+
+The Face Detection event data type.
+
+```ts
+interface FaceResult {
+    smilingProbability: number;
+    leftEyeOpenProbability: number;
+    rightEyeOpenProbability: number;
+    trackingId: number;
+    bounds: Bounds;
+    headEulerAngleZ: number;
+    headEulerAngleY: number;
+    headEulerAngleX: number;
+}
+```
+
+#### Bounds
+```ts
+interface Bounds {
+    origen: Origin;
+    size: Size;
+}
+```
+#### Origin
+```ts
+interface Origin {
+    x: number;
+    y: number;
+}
+```
+#### Size
+```ts
+interface Size {
+    width: number;
+    height: number;
+}
+```
 
-See [@nativescript/mlkit-core](/packages/mlkit-core/README.md) Usage
 ## License
 
 Apache License Version 2.0
