From 55076426a29a8b7079388c5c541d16fba0b502ac Mon Sep 17 00:00:00 2001 From: Muhammad Rehan Abbasi Date: Sat, 1 Dec 2018 23:28:22 +0500 Subject: [PATCH] Readme update --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 73dd327..88d4fd0 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,12 @@ A library to provide comprehensive unit test coverage of your code considering o `npm install comprehensive-js-coverage` ## Usage + ``` + var coverage = require('comprehensive-js-coverage'); - + coverage('repo_name', 'repo_owner', 'base_branch'); + ``` + This would generate a `/comprehensive_coverage` directory under project root, containing unit test coverage reports for each Pull Request branch and the base branch. ## Tests