facebetter-core 1.5.1 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -32
- package/dist/facebetter-core.js +1 -1
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,36 +1,7 @@
|
|
|
1
1
|
# facebetter-core
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Runtime used by the [facebetter](https://www.npmjs.com/package/facebetter) Web SDK.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
npm install facebetter-core
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
## Usage
|
|
12
|
-
|
|
13
|
-
This package is primarily used by `facebetter` SDK. You typically don't need to use it directly.
|
|
14
|
-
|
|
15
|
-
If you need to use it directly:
|
|
16
|
-
|
|
17
|
-
```javascript
|
|
18
|
-
import createFaceBetterModule from 'facebetter-core';
|
|
19
|
-
|
|
20
|
-
const Module = await createFaceBetterModule({
|
|
21
|
-
// Emscripten module options
|
|
22
|
-
});
|
|
23
|
-
|
|
24
|
-
// Module is now ready to use
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
## Build
|
|
28
|
-
|
|
29
|
-
This package is built by CMake when compiling for WebAssembly (Emscripten). The output file `facebetter-core.js` is generated in the `dist/` directory.
|
|
30
|
-
|
|
31
|
-
## Note
|
|
32
|
-
|
|
33
|
-
- The WASM binary and data files are embedded in the JS file (SINGLE_FILE=1)
|
|
34
|
-
- This is an internal package, typically used by `facebetter` SDK
|
|
35
|
-
- Version should match the `facebetter` SDK version
|
|
5
|
+
You do not need to install or import this package in application code. `npm install facebetter` already pulls a matching `facebetter-core` (same major/minor; keep the two versions in lockstep).
|
|
36
6
|
|
|
7
|
+
Direct `import` is only for advanced cases that need the raw module factory. For beauty effects, filters, and makeup, use `facebetter`.
|