From caa5b4bc677f52787b1221a34c25367dc9993f28 Mon Sep 17 00:00:00 2001 From: cgewecke Date: Tue, 10 Sep 2019 16:01:26 -0700 Subject: [PATCH] More README edits --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index cdfd1e5..810a3eb 100644 --- a/README.md +++ b/README.md @@ -21,10 +21,10 @@ $ npm install --save-dev solidity-coverage ``` ### Usage notes: + For pragma solidity >=0.4.22 <0.6.0 / Petersburg -+ Tests run more slowly while coverage is being generated. -+ Contracts consume more gas while coverage is being generated. -+ solidity-coverage launches its own in-process ganache instance. You can - set its [options](https://github.com/trufflesuite/ganache-core#options) via ++ Coverage runs tests a little more slowly. ++ Coverage distorts gas consumption. ++ Coverage launches its own in-process ganache instance. You can + set [ganache options](https://github.com/trufflesuite/ganache-core#options) via the `providerOptions` key in your `.solcover.js` config file. ### Truffle >= V5: setup and run @@ -43,12 +43,13 @@ truffle run coverage [options] ### Command Options -| Option | Example | Description | -|--------------|--------------------------------|--------------------------------------------------------------------------------------------------------------------------------| -| --file | --file="test/registry/*.js" | Filename or glob describing a subset of JS tests to run. (Globs must be enclosed by quotes.) | +| Option | Example | Description | +|--------------|--------------------------------|-------------| +| --file | --file="test/registry/*.js" | Filename or glob describing a subset of JS tests to run. (Globs must be enclosed by quotes.)| | --solcoverjs | --solcoverjs ./../.solcover.js | Relative path from working directory to config. Useful for monorepo packages that share settings. (Path must be "./" prefixed) | -| --version | | Version info | -| --help | | Usage notes | +| --version | | Version info | +| --help | | Usage notes | +|| || ### Config Options