@nesso-how/plugin-example 0.4.0 → 0.5.0

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 CHANGED
@@ -1,12 +1,12 @@
1
- # Uppercase labels
1
+ # Plugin Example
2
2
 
3
- The official Nesso action plugin example, published as [`@nesso-how/plugin-example`](https://www.npmjs.com/package/@nesso-how/plugin-example). It uppercases labels in the invoked view with one undoable batch. Shared concepts change in every view containing them.
3
+ The official Nesso plugin example: an **Uppercase labels** action and a React **Concept Quiz** with persistent progress. See [`src/index.ts`](src/index.ts) and [`src/Quiz.tsx`](src/Quiz.tsx).
4
4
 
5
5
  ## Install and try
6
6
 
7
- In the desktop app, open Settings → Plugins, search for `@nesso-how/plugin-example`, and install it. Approve its declared access to concept labels.
7
+ In the desktop app, open Settings → Plugins, search for `@nesso-how/plugin-example`, and install it. Approve its declared access to concept labels, interactive panels, and private storage. The panel example requires the SDK and app versions containing central-panel support; build from this checkout until that SDK release is published.
8
8
 
9
- Run **Uppercase labels** from a view's context menu in the Explorer, or from the view's actions in the Inspector with no concepts or relations selected. Use Undo to restore the original labels.
9
+ Run either action from a view's context menu in the Explorer, or from its actions in the Inspector with nothing selected.
10
10
 
11
11
  ## Build your own
12
12
 
@@ -17,9 +17,9 @@ npm install
17
17
  npm run build
18
18
  ```
19
19
 
20
- The build typechecks `src/index.ts` and bundles it with the package metadata into a self-contained `dist/index.js`.
20
+ The Vite configuration bundles code and imported CSS into `dist/index.js`, leaving React and React DOM to Nesso. See the [UI contract](../README.md#action-ui) for runtime requirements.
21
21
 
22
- Choose your own package name and action ID before publishing a derived plugin.
22
+ Choose your own package name, plugin metadata, and action IDs and labels before publishing.
23
23
 
24
24
  ## Test an unpublished build
25
25