detection-lib - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "detection-lib",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "main": "src/DetectorFactory.js",
@@ -5,0 +5,0 @@ "scripts": {

README.md

@@ -45,2 +45,29 @@
 }
+```
+
+## API 
+
+#### createDetector(options)
+
+- **options.type: 'face' | 'qr' | string** — The type of detector to create.
+- Returns a detector instance with an async detect(input) method
+
+### Detector Interface
+All detectors implement:
+
+```
+async detect(input: HTMLVideoElement | HTMLImageElement | HTMLCanvasElement): Promise<DetectionResult>
+```
+
+### DetectionResult
+- **type**: string — The detector type ('face', 'qr', etc.)
+- **boxes**: Array of { x, y, w, h, score? } (for face, etc.)
+- **data**: Any extra data (for QR, etc.)
+
+### Extending
+To add a new detector:
+```
+1. Create a new file in src/detectors/ (e.g., myDetector.js).
+2. Implement a class with a detect() method.
+3. Register it in the factory in src/DetectorFactory.js.
 ```

No alert changes

Improved metrics

Total package byte prevSize

4771

19.22%

Number of lines in readme file

72

60%

No dependency changes