chromonym 1.3.0 → 1.3.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.
Files changed (2) hide show
  1. package/README.md +15 -6
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -11,7 +11,8 @@
11
11
  # chromonym
12
12
 
13
13
  [![npm version](https://img.shields.io/npm/v/chromonym?color=cb3837&logo=npm)](https://www.npmjs.com/package/chromonym)
14
- [![bundle size](https://img.shields.io/bundlephobia/minzip/chromonym?label=gzip&color=44cc11)](https://bundlephobia.com/package/chromonym)
14
+ [![publish size](https://badgen.net/packagephobia/publish/chromonym?color=green)](https://packagephobia.com/result?p=chromonym)
15
+ [![install size](https://badgen.net/packagephobia/install/chromonym?color=green)](https://packagephobia.com/result?p=chromonym)
15
16
  [![Types: included](https://img.shields.io/npm/types/chromonym?color=3178c6&logo=typescript)](https://www.npmjs.com/package/chromonym)
16
17
  [![CI](https://github.com/simiancraft/chromonym/actions/workflows/ci.yml/badge.svg)](https://github.com/simiancraft/chromonym/actions/workflows/ci.yml)
17
18
  [![codecov](https://codecov.io/gh/simiancraft/chromonym/branch/main/graph/badge.svg)](https://codecov.io/gh/simiancraft/chromonym)
@@ -21,6 +22,12 @@
21
22
 
22
23
  **Tree-shakeable color naming for TypeScript.** Identify, resolve, and convert colors across CSS, X11, and Pantone — with 5 perceptual distance metrics. Add your own colorspaces and metrics as you need them.
23
24
 
25
+ <p align="center">
26
+ <a href="https://simiancraft.github.io/chromonym/">
27
+ <img src=".github/assets/chromonym-demo.gif" alt="chromonym demo — scrub a color, see the nearest name update live" width="800" />
28
+ </a>
29
+ </p>
30
+
24
31
  Built as a *color-strategy machine*: the identification and resolution mechanism is the same across every colorspace, so plugging in a new set (RAL, HKS, NCS, or a custom brand palette) is one file. For color *manipulation* (mixing, scales, gamut mapping), reach for [`chroma-js`](https://gka.github.io/chroma.js/) or [`color.js`](https://colorjs.io/) — chromonym is the tool for *naming*.
25
32
 
26
33
  ```ts
@@ -40,10 +47,6 @@ convert({ h: 120, s: 100, l: 50 }, { format: 'HEX' }) // '#00ff00'
40
47
  identify('#ff8080') // 'lightcoral'
41
48
  ```
42
49
 
43
- > ### Pantone® trademark notice
44
- >
45
- > **Pantone®** is a registered trademark of **Pantone LLC**. Chromonym is **not affiliated with, endorsed by, or certified by Pantone LLC**. The `pantone` colorspace ships **community-derived sRGB approximations** of the Pantone Coated (C) set. Values will **not** match a licensed Pantone reference exactly and are unsuitable for print color specification. See [`NOTICE.md`](./NOTICE.md) for full text.
46
-
47
50
  ## Install
48
51
 
49
52
  ```sh
@@ -263,7 +266,7 @@ Each ring is a directory; each leaf is a file. Green is covered, red is gaps.
263
266
 
264
267
  ## See also
265
268
 
266
- chromonym deliberately limits its scope to color *naming*. For other color-related work, reach for tools that do those things well:
269
+ chromonym deliberately limits its scope to color *naming* (resolving and identifying) and lightweight conversions. For other color-related work, reach for tools that do those things well:
267
270
 
268
271
  - **[color.js](https://colorjs.io/)** — modern, spec-first color library by the CSS Color WG authors. CSS Color 4/5, OKLAB, P3, gamut mapping, interpolation, ΔE.
269
272
  - **[chroma.js](https://gka.github.io/chroma.js/)** — color mixing, scales, interpolation, contrast ratios, luminance.
@@ -272,3 +275,9 @@ chromonym deliberately limits its scope to color *naming*. For other color-relat
272
275
  ## License
273
276
 
274
277
  MIT © [the-simian](https://github.com/the-simian)
278
+
279
+ ---
280
+
281
+ > ### Pantone® trademark notice
282
+ >
283
+ > **Pantone®** is a registered trademark of **Pantone LLC**. Chromonym is **not affiliated with, endorsed by, or certified by Pantone LLC**. The `pantone` colorspace ships **community-derived sRGB approximations** of the Pantone Coated (C) set. Values will **not** match a licensed Pantone reference exactly and are unsuitable for print color specification. See [`NOTICE.md`](./NOTICE.md) for full text.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "chromonym",
3
- "version": "1.3.0",
3
+ "version": "1.3.1",
4
4
  "description": "Tree-shakeable color-naming primitive for TypeScript. Identify, resolve, and convert colors across CSS, X11, and Pantone colorspaces — with perceptual distance metrics (CIEDE2000).",
5
5
  "keywords": [
6
6
  "color",