updated readme

pull/13/head
Vladimir Mandic 2020-09-01 09:28:44 -04:00
parent b360bc0a84
commit b17750863b
1 changed files with 17 additions and 4 deletions

View File

@ -40,16 +40,21 @@ For example as a script:
<script src="/dist/face-api.min.js"></script> <!-- minified version / 320KB --> <script src="/dist/face-api.min.js"></script> <!-- minified version / 320KB -->
``` ```
or as a module using `require`: Or install a module:
```bash
npm install @tensorflow/tfjs @vladmandic/face-api
```
Use module using `require` (recommended for VanillaJS):
```js ```js
# npm install @tensorflow/tfjs @vladmandic/face-api
const tf = require('@tensorflow/tfjs'); const tf = require('@tensorflow/tfjs');
const faceapi = require('@vladmandic/face-api'); const faceapi = require('@vladmandic/face-api');
``` ```
or as a module using `import`: Use module in a JavaScript project using `import`:
(NodeJS requires `"type": "module"` inside `package.json` to support `import` statements) (NodeJS requires `"type": "module"` inside `package.json` to support `import` statements)
```js ```js
@ -57,6 +62,14 @@ import tf from '@tensorflow/tfjs';
import faceapi from '@vladmandic/face-api'; import faceapi from '@vladmandic/face-api';
``` ```
Use module in a TypeScript project:
(TSC will compile this to `require` statements)
```js
import * as tf from '@tensorflow/tfjs';
import * as faceapi from '@vladmandic/face-api';
```
## Weights ## Weights
Pretrained models and their weights are includes in `./model`. Pretrained models and their weights are includes in `./model`.
@ -66,7 +79,7 @@ Pretrained models and their weights are includes in `./model`.
Included in `./dist` are: Included in `./dist` are:
- face-api.cjs: CJS format, used by NodeJS import/require (default for node and browser require/import) - face-api.cjs: CJS format, used by NodeJS import/require (default for node and browser require/import)
- face-api.ejs: ESM format, used by Browser - face-api.ejs: ESM format, used by Browser (provided as an alternative)
- face-api.js: IIFE format, used by Browser (default for browser script) - face-api.js: IIFE format, used by Browser (default for browser script)
- face-api.min.js: Minified IIFE format, used by Browser - face-api.min.js: Minified IIFE format, used by Browser