Skip to content

Commit

Permalink
update documentation on plugins regarding needs
Browse files Browse the repository at this point in the history
  • Loading branch information
staltz committed Jan 5, 2024
1 parent d72f20b commit e2c4e80
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions PLUGINS.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Plugins are simply NodeJS modules that export an `object` of form `{ name, versi

module.exports = {
name: 'bluetooth',
needs: ['conn'],
version: '5.0.1',
manifest: {
localPeers: 'async',
Expand Down Expand Up @@ -87,6 +88,15 @@ will be available at `node.fooBar`.
A `plugin.name` can also be an `'object`. This object will be merged
directly with the

### `plugin.needs` (Array) _optional_

An array of strings which are the names of other plugins that this plugin
depends on. If those plugins are not present, then secret-stack will throw
an error indicating that the dependency is missing.

Use this field to declare dependencies on other plugins, and this should
facilitate the correct usage of your plugin.

### `plugin.version` (String) _optional_

NOTE - not currently used anywhere functionally
Expand Down

0 comments on commit e2c4e80

Please sign in to comment.