web3-plugin-template

This is a template for creating a repository for web3.js plugin.

How to use

1. Create your project out of this template.

   You can do so by pressing on Use this template on the above right corner and then select Create new Repositor. Please, use the convention web3-plugin-<name> for your repo name.

2. Update the name and description fileds at your package.json.

   Chose a name like: @<organization>/web3-plugin-<name> (or the less better web3-plugin-<name>).

3. Update the code inside src folder.

4. Modify and add tests inside test folder.

5. Publish to the npm registry.

   You can publish with something like: yarn build && npm publish --access public.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT