Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

6366 Add instructions to the doc for the plugin naming #6446

Merged
merged 4 commits into from
Sep 22, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
@@ -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