Skip to content

Commit

Permalink
docs: add clarification about goals of this project (#33)
Browse files Browse the repository at this point in the history
Clarify project goals: I'd like this project to demonstrate a powerful code coverage solution relying primarily on native V8 functionality, and minimal user-land modules -- @bcoe
  • Loading branch information
bcoe authored and profnandaa committed Sep 22, 2018
1 parent 6cf3601 commit d6bfae2
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,16 @@ The above example will output coverage metrics for `foo.js`.

run `c8 report` to regenerate reports after `c8` has already been run.

## Disclaimer
## Supported Node.js Versions

c8 uses
[bleeding edge Node.js features](https://github.com/nodejs/node/pull/22527),
make sure you're running Node.js `>= 10.10.0`.

## Goals of the Project

A fully functional code coverage solution using only V8's native coverage
features and minimal user-land modules, so that we fit these constraints:

* No parsing of JavaScript code.
* No mucking with Node.js' runtime environment.

0 comments on commit d6bfae2

Please sign in to comment.