From 0c7a4978bd200cb71f5b38d67e6f15d18f112a08 Mon Sep 17 00:00:00 2001 From: "Benjamin E. Coe" Date: Sat, 22 Sep 2018 16:46:34 -0700 Subject: [PATCH] docs: add clarification about goals of this project (#33) 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 --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cc964f48..ef752108 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file