diff --git a/README.md b/README.md index c26baa93..2e6ecbd3 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ -# Human: 3D Face Detection, Body Pose, Hand & Finger Tracking, Iris Tracking, Age & Gender Prediction & Emotion Prediction +# Human Library + +## 3D Face Detection, Body Pose, Hand & Finger Tracking, Iris Tracking, Age & Gender Prediction & Emotion Prediction - [**Documentation**](https://github.com/vladmandic/human#readme) - [**Code Repository**](https://github.com/vladmandic/human) -- [**Package**](https://www.npmjs.com/package/@vladmandic/human) +- [**NPM Package**](https://www.npmjs.com/package/@vladmandic/human) - [**Issues Tracker**](https://github.com/vladmandic/human/issues) - [**Live Demo**](https://vladmandic.github.io/human/demo/demo-esm.html) @@ -30,6 +32,25 @@ Compatible with Browser, WebWorker and NodeJS execution! There are multiple ways to use `Human` library, pick one that suits you: +### Included + +- `dist/human.js`: IIFE format minified bundle with TFJS for Browsers +- `dist/human.esm.js`: ESM format minified bundle with TFJS for Browsers +- `dist/human.esm-nobundle.js`: ESM format non-minified bundle without TFJS for Browsers +- `dist/human.cjs`: CommonJS format minified bundle with TFJS for NodeJS +- `dist/human-nobundle.cjs`: CommonJS format non-minified bundle without TFJS for NodeJS + +All versions include `sourcemap` + +Defaults: +```json + { + "main": "dist/human.cjs", + "module": "dist/human.esm.js", + "browser": "dist/human.esm.js", + } +``` + ### 1. [IIFE](https://developer.mozilla.org/en-US/docs/Glossary/IIFE) script *Simplest way for usage within Browser* @@ -43,8 +64,6 @@ Simply download `dist/human.js`, include it in your `HTML` file & it's ready to IIFE script auto-registers global namespace `human` within global `Window` object This way you can also use `Human` library within embbedded `