facebetter 1.0.0

package/README.md

@@ -0,0 +1,167 @@
+# Facebetter
+
+Face beauty effects SDK with WebAssembly support. Works in browsers, Node.js, and Electron.
+
+## Installation
+
+```bash
+npm install facebetter
+```
+
+## Usage
+
+### Browser (`<script>` tag)
+
+```html
+<script src="node_modules/facebetter/dist/facebetter.js"></script>
+<script>
+  const { BeautyEffectEngine, EngineConfig } = Facebetter;
+  
+  const config = new EngineConfig({
+    appId: 'your-app-id',
+    appKey: 'your-app-key'
+  });
+  
+  const engine = new BeautyEffectEngine(config);
+  
+  await engine.init();
+  
+  // Process image
+  const canvas = document.getElementById('myCanvas');
+  const processed = engine.processImage(canvas);
+  
+  // Draw result
+  const ctx = canvas.getContext('2d');
+  ctx.putImageData(processed, 0, 0);
+</script>
+```
+
+### Vue / React / Vite / Webpack (ES Module)
+
+```javascript
+import { BeautyEffectEngine, EngineConfig } from 'facebetter';
+
+const config = new EngineConfig({
+  appId: 'your-app-id',
+  appKey: 'your-app-key'
+});
+
+const engine = new BeautyEffectEngine(config);
+await engine.init();
+
+// Process image
+const canvas = document.getElementById('myCanvas');
+const processed = engine.processImage(canvas);
+```
+
+**Note for Webpack 5**: Add to `webpack.config.js`:
+```javascript
+experiments: {
+  asyncWebAssembly: true
+}
+```
+
+### Node.js / Electron Main Process
+
+```javascript
+// ESM
+import { BeautyEffectEngine, EngineConfig } from 'facebetter';
+
+// Or CommonJS
+const { getFacebetter } = require('facebetter');
+const { BeautyEffectEngine, EngineConfig } = await getFacebetter();
+
+const config = new EngineConfig({
+  licenseJson: '{"your": "license", "json": "here"}'  // Must provide licenseJson in Node.js
+});
+
+const engine = new BeautyEffectEngine(config);
+await engine.init();
+
+// Process image (use Uint8ClampedArray or Buffer)
+const imageData = new Uint8ClampedArray(width * height * 4);
+const processed = engine.processImage(imageData, width, height);
+```
+
+## API
+
+### EngineConfig
+
+```javascript
+const config = new EngineConfig({
+  appId: 'your-app-id',        // Required if licenseJson not provided
+  appKey: 'your-app-key',      // Required if licenseJson not provided
+  licenseJson: '{"..."}'       // Optional, if provided appId/appKey not needed
+});
+```
+
+### BeautyEffectEngine
+
+```javascript
+const engine = new BeautyEffectEngine(config);
+
+// Initialize
+await engine.init();
+
+// Set beauty parameters
+engine.setBasicParam(BasicParam.Whitening, 0.5);
+engine.setReshapeParam(ReshapeParam.FaceThin, 0.3);
+engine.setMakeupParam(MakeupParam.Lipstick, 0.4);
+
+// Process image
+const processed = engine.processImage(inputImage);
+
+// Cleanup
+engine.destroy();
+```
+
+## Constants
+
+- `BeautyType`: Basic, Reshape, Makeup, Segmentation
+- `BasicParam`: Smoothing, Sharpening, Whitening, Rosiness
+- `ReshapeParam`: FaceThin, FaceVShape, EyeSize, etc.
+- `MakeupParam`: Lipstick, Blush
+- `BackgroundMode`: None, Blur, Image
+- `ProcessMode`: Image, Video
+
+## Building
+
+### Prerequisites
+
+Before building, ensure you have the C++ build artifacts. When using CMake install, WASM files will be automatically installed to `src/engine/web/dist/`. Otherwise, you need to manually place them there:
+
+```
+src/engine/web/dist/
+├── facebetter_wasm.js    # C++ build artifact (must exist before build)
+├── facebetter_wasm.wasm  # C++ build artifact (must exist before build)
+└── facebetter_wasm.data  # C++ build artifact (must exist before build)
+```
+
+**Note**: When using `cmake --install`, WASM files are automatically installed to `src/engine/web/dist/`. If building manually, ensure WASM files are in `src/engine/web/dist/` before running `npm run build`.
+
+### Build Steps
+
+```bash
+# 1. Install dependencies
+npm install
+
+# 2. Build all formats
+npm run build
+
+# 3. Build production version (with minification)
+npm run build:prod
+
+# 4. Build development version (with sourcemap)
+npm run build:dev
+```
+
+The build process will:
+1. Build UMD version (`src/engine/web/dist/facebetter.js`) for browser `<script>` tags
+2. Build ESM version (`src/engine/web/dist/facebetter.esm.js`) for Vue/React/Vite
+
+**Output directory**: All build artifacts are generated in `src/engine/web/dist/` directory, ready for npm publish.
+
+## License
+
+MIT
+