@lumiastream/plugin 0.1.10 → 0.1.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -40,7 +40,7 @@ Every plugin requires a `manifest.json` file that describes your plugin, its met
|
|
|
40
40
|
|
|
41
41
|
```json
|
|
42
42
|
{
|
|
43
|
-
"id": "
|
|
43
|
+
"id": "my_awesome_plugin",
|
|
44
44
|
"name": "My Awesome Plugin",
|
|
45
45
|
"version": "1.0.0",
|
|
46
46
|
"author": "Your Name",
|
|
@@ -92,7 +92,7 @@ See the [API reference](./docs/api-reference.md) for the full surface area.
|
|
|
92
92
|
|
|
93
93
|
The CLI is distributed separately via `lumia-plugin`. Use it with `npx` (requires npm 7+).
|
|
94
94
|
|
|
95
|
-
- `npx lumia-plugin create
|
|
95
|
+
- `npx lumia-plugin create my_plugin` scaffold a feature-rich sample plugin showing logging, variables, and alerts
|
|
96
96
|
- `npx lumia-plugin validate ./path/to/plugin` check `manifest.json`, entry files, and config for common mistakes
|
|
97
97
|
- `npx lumia-plugin build ./path/to/plugin --out ./plugin.lumiaplugin` bundle the directory into a distributable archive
|
|
98
98
|
|
|
@@ -105,10 +105,8 @@ The CLI is distributed separately via `lumia-plugin`. Use it with `npx` (require
|
|
|
105
105
|
|
|
106
106
|
## Examples
|
|
107
107
|
|
|
108
|
-
- `examples/basic-logger` – Smallest possible plugin: logs lifecycle events and handles a single action.
|
|
109
|
-
- `examples/toast-notifier` – Demonstrates settings + actions to trigger Lumia toast notifications.
|
|
110
|
-
- `examples/variable-counter` – Shows how to persist state via Lumia variables and support multiple actions.
|
|
111
108
|
- `examples/rumble` – Plain JavaScript Rumble livestream plugin that polls the API, updates variables, and fires alerts.
|
|
109
|
+
<!-- TODO: add more from examples -->
|
|
112
110
|
|
|
113
111
|
## License
|
|
114
112
|
|