notify-me-wl 1.4.4 → 2.0.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
@@ -16,9 +16,23 @@ This JavaScript widget allows users to register their interest in a product that
16
16
  Add the following script to your HTML to include the widget:
17
17
 
18
18
  ```html
19
- <script src="https://cdn.jsdelivr.net/npm/notify-me-wl/index.js"></script>
19
+ <script src="https://cdn.jsdelivr.net/npm/notify-me-wl/build/notify-me-wl.min.js"></script>
20
20
  ```
21
21
 
22
+ ### Development / Build
23
+
24
+ Source lives in `src/` (TypeScript) and is bundled with Rollup into `build/`.
25
+
26
+ ```bash
27
+ npm install # install dev dependencies
28
+ npm run build # emit build/notify-me-wl.js and build/notify-me-wl.min.js
29
+ npm run dev # rebuild on change (watch mode)
30
+ npm run typecheck # type-check without emitting
31
+ ```
32
+
33
+ > **v2.0.0 path change:** the distributed bundle moved from `index.js` to
34
+ > `build/notify-me-wl.min.js`. Update embeds to the new CDN URL above.
35
+
22
36
  ### Usage
23
37
 
24
38
  Add a button to your HTML where you want the widget to appear. The button should have an `id` of `popup-open`, a `data-fields` attribute with the fields you want to include in the form (as a JSON string), and a `data-type` attribute to specify the widget type (`notify-me` or `coming-soon`).