Skip to content

Commit

Permalink
docs: update plugin registration in installation.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hasith committed Sep 8, 2024
1 parent 17c8878 commit ea931ec
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ File: src/productled-config.json

```json
{
"spotlights": []
"hooks": []
}
```

In this configuration file, you'll specify the settings and options for the plugins you're using. For now, we've included an empty array for spotlights, but you'll populate this with your spotlight definitions later.
In this configuration file, you'll specify the settings and options for the plugins you're using. For now, we've included an empty array, but you'll populate this with your plugin definitions later.

## Initialize at Application Start

Expand All @@ -67,7 +67,7 @@ const productled = Productled.getInstance();
productled.loadConfig(productledConf);

// Register the plugins
productled.registerPlugin(new SpotlightPlugin());
productled.registerPlugins(new SpotlightPlugin(), new ToolTipPlugin());
```

In this example, we're initializing the Productled instance, loading the configuration from productled-config.json, and registering the SpotlightPlugin plugin. You can register additional plugins similarly.
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/spotlight.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ const productled = Productled.getInstance();
productled.loadConfig(productledConf);

// Register the plugins
productled.registerPlugin(new SpotlightPlugin());
productled.registerPlugins(new SpotlightPlugin());
```

## Configuring Spotlights
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/tooltip.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ const productled = Productled.getInstance();
productled.loadConfig(productledConf);

// Register the plugin
productled.registerPlugin(new TooltipPlugin());
productled.registerPlugins(new TooltipPlugin());
```

## Configuring Tooltips
Expand Down

0 comments on commit ea931ec

Please sign in to comment.