quadqr-js 1.0.0 → 1.0.1

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
@@ -593,7 +593,7 @@ console.log(result.text);
593
593
  The `quadqr-js` package can be loaded directly from npm-backed CDNs:
594
594
 
595
595
  ```html
596
- <script src="https://cdn.jsdelivr.net/npm/quadqr-js@1.0.0/dist/quadqr.min.js"></script>
596
+ <script src="https://cdn.jsdelivr.net/npm/quadqr-js@1.0.1/dist/quadqr.min.js"></script>
597
597
  <script>
598
598
  const code = QuadQR.encodeText("Hello from a script tag");
599
599
  </script>
@@ -83,7 +83,7 @@ The global browser build exposes `window.QuadQR` / `globalThis.QuadQR`.
83
83
 
84
84
  ```html
85
85
  <canvas id="qr"></canvas>
86
- <script src="https://cdn.jsdelivr.net/npm/quadqr-js@1.0.0/dist/quadqr.min.js"></script>
86
+ <script src="https://cdn.jsdelivr.net/npm/quadqr-js@1.0.1/dist/quadqr.min.js"></script>
87
87
  <script>
88
88
  const code = QuadQR.encodeText("Hello CDN");
89
89
 
@@ -97,7 +97,7 @@ The global browser build exposes `window.QuadQR` / `globalThis.QuadQR`.
97
97
  ## unpkg
98
98
 
99
99
  ```html
100
- <script src="https://unpkg.com/quadqr-js@1.0.0/dist/quadqr.min.js"></script>
100
+ <script src="https://unpkg.com/quadqr-js@1.0.1/dist/quadqr.min.js"></script>
101
101
  ```
102
102
 
103
103
  ## Direct CDN ESM
@@ -107,7 +107,7 @@ The global browser build exposes `window.QuadQR` / `globalThis.QuadQR`.
107
107
  import {
108
108
  encodeText,
109
109
  renderToCanvas
110
- } from "https://cdn.jsdelivr.net/npm/quadqr-js@1.0.0/dist/browser.js";
110
+ } from "https://cdn.jsdelivr.net/npm/quadqr-js@1.0.1/dist/browser.js";
111
111
 
112
112
  const code = encodeText("ES module CDN");
113
113
  renderToCanvas(code, document.querySelector("#qr"));
@@ -134,4 +134,4 @@ WASM is optional. The normal JavaScript implementation remains available if it c
134
134
 
135
135
  ## Production recommendation
136
136
 
137
- Pin a concrete package version such as `@1.0.0` in CDN URLs so an existing site does not silently change when a newer package version becomes available.
137
+ Pin a concrete package version such as `@1.0.1` in CDN URLs so an existing site does not silently change when a newer package version becomes available.
@@ -147,7 +147,7 @@ PNG generation and decoding are built into the Node.js adapter.
147
147
 
148
148
  ```html
149
149
  <canvas id="qr"></canvas>
150
- <script src="https://cdn.jsdelivr.net/npm/quadqr-js@1.0.0/dist/quadqr.min.js"></script>
150
+ <script src="https://cdn.jsdelivr.net/npm/quadqr-js@1.0.1/dist/quadqr.min.js"></script>
151
151
  <script>
152
152
  const code = QuadQR.encodeText("No build step");
153
153
  QuadQR.renderToCanvas(code, document.querySelector("#qr"));
package/docs/WASM.md CHANGED
@@ -56,7 +56,7 @@ You can also provide WASM bytes directly through the `bytes` option.
56
56
  When the classic `quadqr.min.js` global build is loaded from a CDN, `QuadQR.initWasm()` resolves the bundled sibling WASM asset from the same package/version location.
57
57
 
58
58
  ```html
59
- <script src="https://cdn.jsdelivr.net/npm/quadqr-js@1.0.0/dist/quadqr.min.js"></script>
59
+ <script src="https://cdn.jsdelivr.net/npm/quadqr-js@1.0.1/dist/quadqr.min.js"></script>
60
60
  <script>
61
61
  await QuadQR.initWasm();
62
62
  </script>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "quadqr-js",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "QuadQR: experimental four-state RGBW matrix code with Spectrum ECC, browser/Node scanning, CDN builds, and optional AES-256-GCM secure payloads.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",
@@ -1,109 +0,0 @@
1
- # Publishing QuadQR to npm
2
-
3
- QuadQR is published on npm as [`quadqr-js`](https://www.npmjs.com/package/quadqr-js). The repository package name is `quadqr-js`.
4
-
5
- The QuadQR project/brand, browser global (`QuadQR`), CLI executable (`quadqr`), and generated filenames remain unchanged. Only the npm package identifier is `quadqr-js`.
6
-
7
- ## 1. Create/sign in to npm
8
-
9
- Create an account at https://www.npmjs.com/ and enable two-factor authentication.
10
-
11
- Then authenticate the CLI:
12
-
13
- ```bash
14
- npm login
15
- ```
16
-
17
- Check the active account:
18
-
19
- ```bash
20
- npm whoami
21
- ```
22
-
23
- ## 2. Install repository dependencies
24
-
25
- QuadQR currently has no runtime dependencies, but run:
26
-
27
- ```bash
28
- npm install
29
- ```
30
-
31
- so your local package lock and npm metadata are synchronized.
32
-
33
- ## 3. Verify the package metadata
34
-
35
- ```bash
36
- npm view quadqr-js
37
- ```
38
-
39
- Confirm the published package and current version before releasing an update.
40
-
41
- ## 4. Run the full release checks
42
-
43
- ```bash
44
- npm test
45
- npm run benchmark
46
- npm run pack:check
47
- ```
48
-
49
- `pack:check` rebuilds `dist/` and displays exactly what npm will include.
50
-
51
- You can inspect the final tarball too:
52
-
53
- ```bash
54
- npm pack
55
- ```
56
-
57
- ## 5. Publish
58
-
59
- The package is an unscoped public package and `publishConfig.access` is already set to `public`, so publish with:
60
-
61
- ```bash
62
- npm publish
63
- ```
64
-
65
- npm publishing requires an account that satisfies npm's current 2FA/authentication requirements.
66
-
67
- ## 6. Verify installation from a clean directory
68
-
69
- ```bash
70
- mkdir quadqr-consumer-test
71
- cd quadqr-consumer-test
72
- npm init -y
73
- npm install quadqr-js
74
- ```
75
-
76
- Then test ESM, Node PNG, and the CLI.
77
-
78
- ```bash
79
- npx quadqr-js keygen
80
- npx quadqr-js encode "Hello from npm" -o hello.png
81
- npx quadqr-js decode hello.png
82
- ```
83
-
84
- ## 7. Verify CDN availability
85
-
86
- After npm and CDN caches update, test:
87
-
88
- ```text
89
- https://cdn.jsdelivr.net/npm/quadqr-js@1.0.0/dist/quadqr.min.js
90
- https://unpkg.com/quadqr-js@1.0.0/dist/quadqr.min.js
91
- ```
92
-
93
- Then call `QuadQR.encodeText(...)` from a plain HTML page.
94
-
95
- ## Releasing the next version
96
-
97
- Use semantic versioning:
98
-
99
- ```bash
100
- npm version patch
101
- # or
102
- npm version minor
103
- # or
104
- npm version major
105
- ```
106
-
107
- Then run the release checks again and publish.
108
-
109
- Never reuse an npm version that has already been published. Published package versions are immutable.