Skip to content

Commit

Permalink
docs: Add introductory section to README (#1339)
Browse files Browse the repository at this point in the history
  • Loading branch information
mrsarm committed Sep 29, 2020
1 parent 046a1a9 commit 37ce8a6
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Expand Up @@ -14,6 +14,12 @@ Istanbul's state of the art command line interface, with support for:
* applications that spawn subprocesses.
* source mapped coverage of Babel and TypeScript projects

## How Istanbul works

Istanbul instruments your ES5 and ES2015+ JavaScript code with line counters, so that you can track how well your unit-tests exercise your codebase.

The `nyc` command-line-client for Istanbul works well with most JavaScript testing frameworks: tap, mocha, AVA, etc.

## Installation & Usage

Use your package manager to add it as a dev dependency: `npm i -D nyc` or `yarn add -D nyc`.
Expand Down

0 comments on commit 37ce8a6

Please sign in to comment.