renamed spotlight plugin class

99x-incubator · Aug 31, 2024 · 906a027 · 906a027
1 parent 2a06033
commit 906a027
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 8 deletions.
diff --git a/docs/plugins/index.md b/docs/plugins/index.md
@@ -12,9 +12,20 @@ Productled offers a variety of plugin libraries to extend its capabilities. You
 npm install @productled/<plugin-name>
 ```
 
-Register the plugin with Productled Core at application start.
+e.g.,
+
+```bash
+npm install @productled/spotlights
+```
+
+Register the plugin with Productled Core at application start. e.g., in file: index.tsx
+
+``` typescript
+productled.registerPlugin(new <PluginClass>());
+```
+
+e.g.,
 
-e.g., in file: index.tsx
 ``` typescript
 productled.registerPlugin(new SpotlightPlugin());
 ```

diff --git a/...ductled/spotlights/src/SpotlightPlugin.ts → ...uctled/spotlights/src/SpotlightsPlugin.ts b/...ductled/spotlights/src/SpotlightPlugin.ts → ...uctled/spotlights/src/SpotlightsPlugin.ts
@@ -1,7 +1,7 @@
 import { type Plugin } from "@productled/core";
 import { Spotlight } from "./Spotlight";
 
-class SpotlightPlugin implements Plugin {
+class SpotlightsPlugin implements Plugin {
     private key: string = "spotlights";
 
     get Name(): string {
@@ -22,4 +22,4 @@ class SpotlightPlugin implements Plugin {
     }
 }
 
-export default SpotlightPlugin;
+export default SpotlightsPlugin;
diff --git a/packages/@productled/spotlights/src/index.ts b/packages/@productled/spotlights/src/index.ts
@@ -1,2 +1,2 @@
-import SpotlightPlugin from './SpotlightPlugin';
-export {SpotlightPlugin};
+import SpotlightsPlugin from './SpotlightsPlugin';
+export {SpotlightsPlugin};
diff --git a/packages/samples/react-sample/src/index.tsx b/packages/samples/react-sample/src/index.tsx
@@ -3,7 +3,7 @@ import ReactDOM from 'react-dom/client';
 import './index.css';
 import App from './App';
 import reportWebVitals from './reportWebVitals';
-import { SpotlightPlugin } from '@productled/spotlights';
+import { SpotlightsPlugin } from '@productled/spotlights';
 import productledConf from './productled-config.json';
 import { Productled } from '@productled/core';
 
@@ -16,7 +16,7 @@ const productled = Productled.getInstance();
 // load the configuration
 productled.loadConfig(productledConf);
 // register the plugins
-productled.registerPlugin(new SpotlightPlugin());
+productled.registerPlugin(new SpotlightsPlugin());
 
 root.render(
   <React.StrictMode>