-
Notifications
You must be signed in to change notification settings - Fork 5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
6366 Add instructions to the doc for the plugin naming (#6446)
- Loading branch information
Showing
1 changed file
with
1 addition
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|