From 32bb2d089b2ec9f01ffedc3cada95e9d86286895 Mon Sep 17 00:00:00 2001 From: Dan Schultzer Date: Thu, 22 Sep 2016 11:11:54 -0700 Subject: [PATCH] Update readme --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6bf0720..15944d4 100755 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # node-opencv [![Build Status](https://secure.travis-ci.org/peterbraden/node-opencv.png)](http://travis-ci.org/peterbraden/node-opencv) - +[![Coverage](http://codecov.io/github/peterbraden/node-opencv/coverage.svg?branch=master)](https://codecov.io/gh/peterbraden/node-opencv) [OpenCV](http://opencv.org) bindings for Node.js. OpenCV is the defacto computer vision library - by interfacing with it natively in node, @@ -223,6 +223,20 @@ contours.approxPolyDP(index, epsilon, isClosed); contours.convexHull(index, clockwise); ``` +## Test + +Using [tape](https://github.com/substack/tape). Run with command: + +`npm test`. + +## Code coverage + +Using [istanbul](http://gotwarlost.github.io/istanbul/) and [lcov](http://ltp.sourceforge.net/coverage/lcov.php). Run with command: + +`make cover` + +Build version of `opencv.node` will be generated, and coverage files will be put in `coverage/` directory. These files can be remvoved automatically by running `make clean`. + ## MIT License The library is distributed under the MIT License - if for some reason that doesn't work for you please get in touch.