Readme update

zeezia · Dec 1, 2018 · 5507642 · 5507642
1 parent cafbda4
commit 5507642
Showing 1 changed file with 5 additions and 1 deletion.
diff --git 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