From 4a81392b14d2a80e31f1bfb85bf79c29eb00ab83 Mon Sep 17 00:00:00 2001 From: Tim Lebel Date: Wed, 31 May 2017 00:24:28 -0700 Subject: [PATCH] Add some info to README --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f7d3403..63edf09 100644 --- a/README.md +++ b/README.md @@ -1 +1,25 @@ -npm install node-dlib +node-dlib +========= + +Node wrapper for dlib with limited functionality. + +Build on Debian/Ubuntu: + +```bash +apt install -y libdlib-dev libgif-dev libpng-dev libjpeg-dev +npm i node-dlib +``` + +Basic usage: + +```js +var dlib = require('node-dlib'), + faced = new dlib.FrontalFaceDetector(); + +faced.detect('frame.jpeg', (err, faces) => { + if (err) throw err; + faces.forEach(f => { + console.log('Face at', f.x, f.y); + }); +}); +```