Skip to content

Commit 4f73e15

Browse files
authored
Add buidler config and run info (#440)
* Add buidler config and run info * Sub 'add' for 'use' * Add docs links
1 parent 33b33f9 commit 4f73e15

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

README.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
![npm (tag)](https://img.shields.io/npm/v/solidity-coverage/beta)
55
[![CircleCI](https://circleci.com/gh/sc-forks/solidity-coverage.svg?style=svg)][20]
66
[![codecov](https://codecov.io/gh/sc-forks/solidity-coverage/branch/beta/graph/badge.svg)][21]
7+
[![buidler](https://buidler.dev/buidler-plugin-badge.svg?1)][26]
8+
79

810
## Code coverage for Solidity testing
911
![coverage example][22]
@@ -17,9 +19,9 @@
1719
$ npm install --save-dev solidity-coverage@beta
1820
```
1921

20-
## Truffle V5
22+
### Truffle V5
2123

22-
**Add** this package to your plugins array in `truffle-config.js`
24+
**Add** this package to your plugins array in `truffle-config.js` ([Truffle docs][27])
2325
```javascript
2426
module.exports = {
2527
networks: {...},
@@ -31,6 +33,21 @@ module.exports = {
3133
truffle run coverage [command-options]
3234
```
3335

36+
### Buidler
37+
38+
**Add** the plugin in `buidler.config.js` ([Buidler docs][26])
39+
```javascript
40+
usePlugin('solidity-coverage')
41+
42+
module.exports = {
43+
networks: {...},
44+
}
45+
```
46+
**Run**
47+
```
48+
npx buidler coverage [command-options]
49+
```
50+
3451
## Usage notes:
3552
+ Coverage runs tests a little more slowly.
3653
+ Coverage launches its own in-process ganache server.
@@ -62,7 +79,7 @@ module.exports = {
6279
```
6380

6481

65-
| Option <img width=200/>| Type <img width=200/> | Default <img width=700/> | Description <img width=1000/> |
82+
| Option <img width=200/>| Type <img width=200/> | Default <img width=1300/> | Description <img width=800/> |
6683
| ------ | ---- | ------- | ----------- |
6784
| silent | *Boolean* | false | Suppress logging output |
6885
| client | *Object* | `require("ganache-core")` | Useful if you need a specific ganache version. |
@@ -152,3 +169,5 @@ $ yarn
152169
[23]: https://github.com/sc-forks/solidity-coverage/blob/beta/docs/advanced.md#workflow-hooks
153170
[24]: https://github.com/sc-forks/solidity-coverage/blob/beta/docs/advanced.md#skipping-tests
154171
[25]: https://github.com/sc-forks/solidity-coverage/issues/417
172+
[26]: https://buidler.dev/
173+
[27]: https://www.trufflesuite.com/docs

0 commit comments

Comments
 (0)