retail-print-kit 0.2.2 → 0.2.3

package/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+## 0.2.3 (2026-10-05)
+
+* Website with a landing page and ten task guides (receipts, Electron, cash drawer, Star TSP100, labels, templates, QR and barcodes, logos, discovery and status, migration from escpos / node-thermal-printer).
+* The designer moved to `/designer/` on the site; `sitemap.xml`, `robots.txt`, `llms.txt` and `llms-full.txt` are published.
+* README: guides and FAQ sections. Package description leads with the printer families.
+
+## 0.2.2 (2026-10-05)
+
+* A plain install is now 4 packages and under 2 MB with no native modules (was 34 packages and 30 MB).
+* `@napi-rs/canvas` is an optional peer, as intended; it was being installed for everyone.
+* QR codes are generated with the dependency-free `qrcode-generator`; text is encoded as UTF-8.
+
+## 0.2.1 (2026-10-03)
+
+* The repository and the designer address were renamed to `retail-print-kit`; all links follow.
+
+## 0.2.0 (2026-10-03)
+
+* Images and logos: `loadImage` with optional Floyd-Steinberg dithering, `ditherRgba`, `serializeBitmap`, a template `image` block, logo upload in the designer.
+* `discoverNetworkPrinters` finds raw-printing hosts on the local networks and can identify each.
+* CLI: `verify`, `verify-label`, `discover`, `image`. A hardware checklist documents what to confirm on real units.
+
+## 0.1.0 (2026-10-03)
+
+First release.
+
+* ESC/POS, Star Line Mode and Star raster encoders with printer profiles.
+* Network, USB and serial transports; printer status and `identify`.
+* Receipt templates, HTML and PNG previews.
+* Label printing in ZPL, TSPL and EZPL with an SVG preview and label templates.
+* Browser bundle and the template designer.
+* CLI: `test`, `drawer`, `status`, `identify`, `preview`, `print`, `profiles`, `list`.

package/README.md

@@ -10,7 +10,7 @@ A modern replacement for `escpos` / `node-thermal-printer`: ESC/POS **and** Star
 network / serial, printer profiles instead of model `if`s, receipt and label **templates**, live
 **previews**, a visual **designer**, and a CLI for testing hardware in the field.
 
-**[Open the designer](https://arka162.github.io/retail-print-kit/)** · [Printer matrix](docs/printer-matrix.md) · [Hardware checklist](docs/hardware-checklist.md)
+**[Website](https://arka162.github.io/retail-print-kit/)** · **[Designer](https://arka162.github.io/retail-print-kit/designer/)** · [Guides](https://arka162.github.io/retail-print-kit/guides/) · [Printer matrix](docs/printer-matrix.md) · [Changelog](CHANGELOG.md)
 
 ![Receipt designer](https://raw.githubusercontent.com/arka162/retail-print-kit/main/docs/images/designer-receipt.png)
 
@@ -77,6 +77,19 @@ const { UsbTransport } = require('retail-print-kit/usb');       // new UsbTransp
 const { SerialTransport } = require('retail-print-kit/serial'); // new SerialTransport('COM3', { baudRate: 9600 })
 ```
 
+## Guides
+
+* [Print a receipt from Node.js on an ESC/POS thermal printer](https://arka162.github.io/retail-print-kit/guides/print-receipt-nodejs.html)
+* [Print receipts from an Electron app](https://arka162.github.io/retail-print-kit/guides/electron-receipt-printing.html)
+* [Open a cash drawer](https://arka162.github.io/retail-print-kit/guides/open-cash-drawer-nodejs.html)
+* [Print to a Star TSP100 or TSP143](https://arka162.github.io/retail-print-kit/guides/star-tsp100-nodejs.html)
+* [Print ZPL, TSPL and EZPL labels](https://arka162.github.io/retail-print-kit/guides/zpl-tspl-ezpl-label-printing-nodejs.html)
+* [Receipt and label templates and the visual designer](https://arka162.github.io/retail-print-kit/guides/receipt-template-designer.html)
+* [QR codes and barcodes](https://arka162.github.io/retail-print-kit/guides/print-qr-code-barcode-receipt.html)
+* [Print a logo or image](https://arka162.github.io/retail-print-kit/guides/print-logo-image-thermal-printer.html)
+* [Find printers on the network and read status](https://arka162.github.io/retail-print-kit/guides/network-printer-discovery-status.html)
+* [Migrating from escpos or node-thermal-printer](https://arka162.github.io/retail-print-kit/guides/escpos-node-thermal-printer-alternative.html)
+
 ## Supported printers
 
 | Family | Profile ids | Command set |
@@ -159,7 +172,7 @@ const label = renderLabel(labelTemplate, data); // from a designer JSON
 
 ## Designer
 
-**https://arka162.github.io/retail-print-kit/** edits receipt and label templates in the browser:
+**https://arka162.github.io/retail-print-kit/designer/** edits receipt and label templates in the browser:
 block palette, nested `each` / `if`, property editor, sample data, live preview, drag-to-position
 on labels, logo upload with dithering, JSON import and export. It runs entirely in the page from
 the browser bundle (`retail-print-kit/browser`); nothing is uploaded.
@@ -201,6 +214,20 @@ npx retail-print-kit profiles
 
 Add `--dry` to any printing command to dump the bytes as hex instead of sending them.
 
+## FAQ
+
+**Does it work in Electron?** Yes, in the main process; the renderer asks for prints over IPC and the
+browser build renders previews.
+
+**Does it need a printer driver?** No. It sends the printer's own commands over TCP, USB or serial,
+so there is no OS print dialog and nothing to install on the machine.
+
+**Why does a Star TSP100 print nothing with other libraries?** It is raster-only and ignores ESC/POS
+text. Use the `star-tsp100` profile.
+
+**Can I print without a printer attached?** `--dry` dumps the bytes, and the HTML, PNG and SVG
+previews show the result.
+
 ## Status of hardware verification
 
 Encoders are covered by byte-exact tests. Items still to be confirmed on real units are listed in

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "retail-print-kit",
-  "version": "0.2.2",
-  "description": "Receipt printers, cash drawers and label printers for Node.js and Electron: ESC/POS (Epson and compatibles), Star, ZPL, TSPL, EZPL; USB, network and serial; templates, previews, a visual designer and a CLI.",
+  "version": "0.2.3",
+  "description": "ESC/POS thermal receipt printer, cash drawer and label printer (ZPL, TSPL, EZPL) library for Node.js and Electron. Epson, Star TSP100 and compatibles over USB, network or serial, with templates, previews, a visual designer and a CLI.",
   "author": "Arkaprova Majumder <arka162@gmail.com>",
   "license": "MIT",
   "repository": {
@@ -37,7 +37,8 @@
     "dist",
     "bin",
     "README.md",
-    "LICENSE"
+    "LICENSE",
+    "CHANGELOG.md"
   ],
   "engines": {
     "node": ">=18"
@@ -47,7 +48,8 @@
     "test": "npm run build && node --test test/run.js",
     "clean": "rm -rf dist",
     "build:browser": "esbuild src/browser.ts --bundle --format=iife --global-name=RetailPrintKit --platform=browser --external:zlib --outfile=dist/browser/retail-print-kit.js --minify --sourcemap && esbuild src/browser.ts --bundle --format=esm --platform=browser --external:zlib --outfile=dist/browser/retail-print-kit.mjs --minify",
-    "prepublishOnly": "npm test"
+    "prepublishOnly": "npm test",
+    "build:site": "node scripts/build-site.js"
   },
   "dependencies": {
     "iconv-lite": "^0.6.3",