Skip to content

Commit

Permalink
6366 Add instructions to the doc for the plugin naming (#6446)
Browse files Browse the repository at this point in the history
  • Loading branch information
avkos authored Sep 22, 2023
1 parent 171b413 commit d036166
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/docs/guides/web3_plugin_guide/plugin_authors.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ To provide type safety and IntelliSense for your plugin users, please refer to t
At the minimum, your plugin should depend on `web3` package version `4.0.2`. This will allow your plugin class to extend the provided `Web3PluginBase` abstract class. However, `web3` shouldn't be listed as a regular dependency, instead it should be listed in your plugin's `package.json` as a [peer dependency](https://nodejs.org/en/blog/npm/peer-dependencies/).

:::important
If the version `[email protected]`, was not available yet. You can use the version `[email protected]`.
It is important to note that the plugin name should be structured as `@<organization>/web3-plugin-<name>` or `web3-plugin-<name>`.
:::

```json
Expand Down

0 comments on commit d036166

Please sign in to comment.