From 3d7007f13d81b30f29fef53345beb9ae461a14ac Mon Sep 17 00:00:00 2001 From: Vladimir Mandic Date: Sun, 7 Mar 2021 07:26:23 -0500 Subject: [PATCH] added documentation --- .markdownlint.json | 6 + README.md | 63 ++- TUTORIAL.md | 744 ++++++++++++++++++++++++++++ dist/face-api.esm.json | 2 +- dist/face-api.json | 2 +- example/facemesh.png | Bin 0 -> 32644 bytes example/node-multiprocess-worker.js | 1 + example/node-multiprocess.js | 1 + example/node-singleprocess.js | 1 + example/webcam.js | 4 +- package-lock.json | 36 +- package.json | 10 +- 12 files changed, 837 insertions(+), 33 deletions(-) create mode 100644 .markdownlint.json create mode 100644 TUTORIAL.md create mode 100755 example/facemesh.png diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..fac5739 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,6 @@ +{ + "MD012": false, + "MD013": false, + "MD033": false, + "MD036": false +} \ No newline at end of file diff --git a/README.md b/README.md index 48c69ba..3df04b3 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This is updated **face-api.js** with latest available TensorFlow/JS as the original face-api.js is not compatible with **tfjs 2.0+**. -Forked from [face-api.js](https://github.com/justadudewhohacks/face-api.js) version **0.22.2** released on March 22nd, 2020 +Forked from [face-api.js](https://github.com/justadudewhohacks/face-api.js) version **0.22.2** which was released on March 22nd, 2020 Currently based on **`TensorFlow/JS` 3.2.0** @@ -62,7 +62,7 @@ Example can be accessed directly using Git pages using URL: @@ -130,6 +130,7 @@ Face-API ships with several pre-build versions of the library: *without* TFJS pre-bundled and using JS engine for platforms where tensorflow binary library version is not available Defaults are: + ```json { "main": "dist/face-api.node-js", @@ -150,7 +151,7 @@ All versions include `sourcemap` and `asset manifest`

-There are several ways to use Face-API: +There are several ways to use Face-API: ### 1. IIFE script @@ -161,7 +162,7 @@ Simply download `dist/face-api.js`, include it in your `HTML` file & it's ready ```html