From 4f73e1585c3ce3586fa79f29a2bbb2d3d8c370f9 Mon Sep 17 00:00:00 2001
From: cgewecke <christophergewecke@gmail.com>
Date: Sun, 24 Nov 2019 17:32:24 -0800
Subject: [PATCH] Add buidler config and run info (#440)

* Add buidler config and run info

* Sub 'add' for 'use'

* Add docs links
---
 README.md | 25 ++++++++++++++++++++++---
 1 file changed, 22 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 3f19fa6..4ff578b 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,8 @@
 ![npm (tag)](https://img.shields.io/npm/v/solidity-coverage/beta)
 [![CircleCI](https://circleci.com/gh/sc-forks/solidity-coverage.svg?style=svg)][20]
 [![codecov](https://codecov.io/gh/sc-forks/solidity-coverage/branch/beta/graph/badge.svg)][21]
+[![buidler](https://buidler.dev/buidler-plugin-badge.svg?1)][26]
+
 
 ## Code coverage for Solidity testing
 ![coverage example][22]
@@ -17,9 +19,9 @@
 $ npm install --save-dev solidity-coverage@beta
 ```
 
-## Truffle V5
+### Truffle V5
 
-**Add** this package to your plugins array in `truffle-config.js`
+**Add** this package to your plugins array in `truffle-config.js` ([Truffle docs][27])
 ```javascript
 module.exports = {
   networks: {...},
@@ -31,6 +33,21 @@ module.exports = {
 truffle run coverage [command-options]
 ```
 
+### Buidler
+
+**Add** the plugin in `buidler.config.js` ([Buidler docs][26])
+```javascript
+usePlugin('solidity-coverage')
+
+module.exports = {
+  networks: {...},
+}
+```
+**Run**
+```
+npx buidler coverage [command-options]
+```
+
 ## Usage notes:
 + Coverage runs tests a little more slowly.
 + Coverage launches its own in-process ganache server.
@@ -62,7 +79,7 @@ module.exports = {
 ```
 
 
-| Option <img width=200/>| Type <img width=200/> | Default <img width=700/> | Description <img width=1000/> |
+| Option <img width=200/>| Type <img width=200/> | Default <img width=1300/> | Description <img width=800/> |
 | ------ | ---- | ------- | ----------- |
 | silent | *Boolean* | false | Suppress logging output |
 | client | *Object* | `require("ganache-core")` | Useful if you need a specific ganache version. |
@@ -152,3 +169,5 @@ $ yarn
 [23]: https://github.com/sc-forks/solidity-coverage/blob/beta/docs/advanced.md#workflow-hooks
 [24]: https://github.com/sc-forks/solidity-coverage/blob/beta/docs/advanced.md#skipping-tests
 [25]: https://github.com/sc-forks/solidity-coverage/issues/417
+[26]: https://buidler.dev/
+[27]: https://www.trufflesuite.com/docs