README-TEMPLATE.md

buidler-example-plugin

A one line description of the plugin

Buidler plugin example.

What

<A longer, one paragraph, description of the plugin>

This plugin will help you with world domination by implementing a simple tic-tac-toe in the terminal.

Installation

<A step-by-step guide on how to install the plugin>

npm install <your npm package name> [list of peer dependencies]

And add the following statement to your buidler.config.js:

usePlugin("<your plugin npm package name>");

Required plugins

<The list of all the required Buidler plugins if there are any>

• @nomiclabs/buidler-web3

Tasks

<A description of each task added by this plugin. If it just overrides internal tasks, this may not be needed>

This plugin creates no additional tasks. <or> This plugin adds the example task to Buidler:

output of npx buidler help example

Environment extensions

<A description of each extension to the Buidler Runtime Environment>

This plugin extends the Buidler Runtime Environment by adding an example field whose type is ExampleBuidlerRuntimeEnvironmentField.

Configuration

<A description of each extension to the BuidlerConfig or to its fields>

This plugin extends the BuidlerConfig's ProjectPaths object with an optional newPath field.

This is an example of how to set it:

module.exports = {
  paths: {
    newPath: "./new-path"
  }
};

Usage

<A description of how to use this plugin. How to use the tasks if there are any, etc.>

There are no additional steps you need to take for this plugin to work.

Install it and access ethers through the Buidler Runtime Environment anywhere you need it (tasks, scripts, tests, etc).

TypeScript support

<This section is needed if you are extending types in your plugin>

You need to add this to your tsconfig.json's files array: "node_modules/<npm package name>/src/type-extensions.d.ts"