Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add clarification about goals of this project #33

Merged
merged 3 commits into from
Sep 22, 2018
Merged

docs: add clarification about goals of this project #33

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b04cb6b
docs: add clarification about goals of this project
Sep 20, 2018
ce29e67
docs: appropriate shorthand for Node
Sep 20, 2018
3e54b3b
fix(docs): fix nitpicks raised in review
profnandaa Sep 22, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
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 Project
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Goals of this Project or Goals of the Project.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On it 👍


A fully functional code coverage solution using only V8's native coverage
features and minimal user-land modules:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Being strict here, this sentence does not really tell me what the following list is for. I would add:

...modules, so that we fit these constraints: or something to that effect.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Glad to make this change 👍


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