cordova-plugin-facedetection-lite - npm Package Compare versions

Comparing version 0.1.1 to 0.3.0

package.json

 {
   "name": "cordova-plugin-facedetection-lite",
-  "version": "0.1.1",
-  "description": "A face detection library in 200 lines of JavaScript for Browser and C for native mobile.",
+  "version": "0.3.0",
+  "description": "A face detection offline with a few lines of code. Was designed to run on old smartphones.",
   "cordova": {
@@ -15,15 +15,23 @@ "id": "cordova-plugin-facedetection-lite",
     "type": "git",
-    "url": "git+ssh://[e-mail]:employer/cordova-plugin-facedetection-lite.git"
+    "url": "https://github.com/luisdemarchi/cordova-plugin-facedetection-lite.git"
   },
+  "issue": "https://github.com/luisdemarchi/cordova-plugin-facedetection-lite/issues",
   "keywords": [
-    "face",
-    "detection",
-    "reconhecer",
     "ecosystem:cordova",
+    "phonegap",
     "cordova-ios",
     "cordova-android",
-    "cordova-browser"
+    "cordova-browser",
+    "facedetection",
+    "face",
+    "detection",
+    "detecção",
+    "lite"
   ],
-  "author": "Luís De Marchi",
+  "author":{
+    "name": "Luís De Marchi",
+    "email": "[e-mail]",
+    "url": "http://www.luisdemarchi.com.br"
+  },
   "license": "unlicense"
 }

README.md

@@ -1,10 +0,64 @@
-# Cordova Face Detection plugin for Android, iOS and Browser v0.1.0
-This plug-in makes detection of faces offline with few lines of code, without the need to use TensorFlow, which is extremely heavy for both Browser and applications.
+# Cordova Plugin Face Detection - LITE
+
+This plug-in makes facial detection offline with a few lines of code, without the need to use TensorFlow. Was designed to run on old smartphones.
 This plugin implementation of the method described in [2013 by Markuš et al](http://arxiv.org/abs/1305.4537).
 
+#### Old devices tested:
+- Moto E - Android 5.1
+- Moto J5 - Android 6.0
+- iPhone 6 - iOS 11
+- iPhone 6s - iOS 12
+
+# Installation
+TODO
+
+# Methods
+TODO
+
+# Sample App
+TODO
+
+<table>
+<tr>
+<td>
+<h3>iOS</h3>
+<img src="https://github.com/luisdemarchi/example-cordova-facedetection/raw/7bb36c3463826f0237705dac6a4c71f2a50f1fd6/images/demo-ios.gif"  height="300">
+</td>
+<td>
+<h3>Browser</h3>
+<img src="https://github.com/luisdemarchi/example-cordova-facedetection/raw/7bb36c3463826f0237705dac6a4c71f2a50f1fd6/images/demo-browser.gif" height="300">
+</td>
+</tr>
+</table>
+
+# Recompiling libraries
+If you modify the C source files, be sure to re-build the compiled libraries.
+
+## Android
+
+You can re-build the `libpicornt.so` binaries using the ndk-build script.
+
+To do so:
+
+- Install Android NDK as [instructed here](https://developer.android.com/ndk/guides/index.html)
+- Add the NDK install path to your path environment variable
+    - By default it's installed under $ANDROID_SDK_HOME/ndk-bundle
+    - e.g. `export PATH=$PATH;$ANDROID_SDK_HOME/ndk-bundle`
+- Set the ANDROID_NDK_HOME environment variable to your NDK install path
+    - e.g. `export ANDROID_NDK_HOME=$ANDROID_SDK_HOME/ndk-bundle`
+- Open terminal in plugin root folder
+- Run `./compile-android` (`compile-android.cmd` on Windows)
+    
+## iOS
+If you modify the C source code in `common/picornt/` you'll need to rebuild the static library and headers in `src/ios/libs`.
+
+- Open terminal in plugin root folder
+- Run `./compile-ios`
+
+
+# Credits
+Created by Luís De Marchi [@luisdemarchi](https://github.com/luisdemarchi) - [Linkedin](https://www.linkedin.com/in/luis5/)
+
+#### Libraries used:
   - Mobile (Language C) : [nenadmarkus/pico](https://github.com/nenadmarkus/pico)
-  - Browser (Language JS): [tehnokv/picojs](https://github.com/tehnokv/picojs)
-
-### TODO / BUG
-- There is a memory leak in the iOS version;
-- Version for android was not developed;
+  - Browser (Language JS): [tehnokv/picojs](https://github.com/tehnokv/picojs)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

64

increased by540%

Number of medium supply chain risk alerts

2

decreased by-33.33%

Worsened metrics

Total package byte prevSize

1826596

decreased by-56.46%

No dependency changes