From 1e3895318eb3be8f1db8c6af2633406d70702c15 Mon Sep 17 00:00:00 2001 From: Chris Tsang Date: Fri, 24 Jul 2026 18:21:09 +0100 Subject: [PATCH] README: surface the 1.0 packages (crates.io, PyPI, npm) Add package badges, a Packages overview table, and note the npm build's supported input formats (PNG/JPEG/GIF/BMP/WebP). Co-Authored-By: Claude Opus 4.8 (1M context) --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 77e211e..d5dd29f 100644 --- a/README.md +++ b/README.md @@ -15,8 +15,26 @@ Download +

+ Rust library on crates.io + CLI on crates.io + Python package on PyPI + Node package on npm +

+ +## Packages + +VTracer 1.0 is a vectorization **framework** (pluggable frontends, curve fitters, color fitting, and output optimization) shipped across four surfaces from this repository: + +| Package | Registry | Source | Use | +| --- | --- | --- | --- | +| `vtracer-cli` | [crates.io](https://crates.io/crates/vtracer-cli) | [`crates/vtracer-cli`](crates/vtracer-cli) | Command-line tool (`vtracer` binary) | +| `vtracer` | [crates.io](https://crates.io/crates/vtracer) | [`crates/vtracer`](crates/vtracer) | Rust library / the framework core | +| `vtracer` | [PyPI](https://pypi.org/project/vtracer/) | [`crates/vtracer-py`](crates/vtracer-py) | Python native extension (pyo3 + maturin) | +| `@visioncortex/vtracer` | [npm](https://www.npmjs.com/package/@visioncortex/vtracer) | [`nodejs`](nodejs) | Node.js WebAssembly build, no native dependency | + ## Introduction visioncortex VTracer is an open source software to convert raster images (like jpg & png) into vector graphics (svg). It can vectorize graphics and photographs and trace the curves to output compact vector files. @@ -148,7 +166,7 @@ See [`crates/vtracer-py`](crates/vtracer-py/README.md) for the full API. ### Node.js Library -[`@visioncortex/vtracer`](https://www.npmjs.com/package/@visioncortex/vtracer) is available for Node as a WebAssembly build (from the [`nodejs`](nodejs/README.md) package) — image decoding and vectorization both run in wasm, so there is **no native dependency**. +[`@visioncortex/vtracer`](https://www.npmjs.com/package/@visioncortex/vtracer) is available for Node as a WebAssembly build (from the [`nodejs`](nodejs/README.md) package) — image decoding and vectorization both run in wasm, so there is **no native dependency**. Decodes PNG, JPEG, GIF, BMP, and WebP; for other formats, decode yourself and pass raw RGBA to `convertPixels`. ```sh npm install @visioncortex/vtracer