color-value-tools 1.1.10 → 1.1.12

package/README.md

@@ -25,6 +25,17 @@ A comprehensive utility library for parsing, converting, manipulating, and analy
 
 ---
 
+## When you'd reach for this
+
+Color stops being a one-time accent pick in a design tool the moment your project needs to convert, compare, and validate it programmatically — that's exactly what Color Value Tools is for.
+
+- **A design system built on custom tokens** — Instead of hand-tuning every shade and tint in Figma, generate the whole scale from one base color with a single function — mathematically even, not "eyeballed."
+- **Your theme switches at runtime** — When the background changes dynamically (dark mode, per-client branding, a user-picked palette), you need to recompute a readable text color and check it against WCAG every time, not hardcode pairs upfront.
+- **Color arrives from different sources** — An API returns hex, a designer hands you HSL, a CSS variable holds a color in the oklch format — you need to normalize all of it to one format without writing a parser for every case.
+- **An accessibility audit of the UI** — You need to quickly show how the palette looks under protanopia or deuteranopia, without installing a separate browser extension.
+
+---
+
 ## Installation
 
 Requires Node.js `18+`. No runtime or peer dependencies — the package is fully framework-agnostic and works in any JS/TS environment (browser, Node, edge runtimes).
@@ -80,6 +91,37 @@ CommonJS:
 const { normalizeColor, mixColors } = require('color-value-tools')
 ```
 
+### More examples
+
+#### What your palette looks like to a colorblind user
+
+`simulateColorBlindness` applies the Vienot 1999 matrices to linearized RGB — you can check contrast before shipping, not guess from a checklist.
+
+```ts
+import { simulateColorBlindness } from 'color-value-tools'
+
+simulateColorBlindness('#e74c3c', 'deuteranopia') // '#9a7b00'
+simulateColorBlindness('#3498db', 'protanopia') // '#5282db'
+
+// Vienot 1999 matrices applied to linearized RGB — good enough to check a
+// palette before it ships, not just guess from a colorblind-safe checklist.
+```
+
+#### A harmony and a shade scale from one color
+
+`triadic` builds three colors 120° apart, `colorShades` a light-to-dark scale of nine steps. One base color in, a coordinated palette out — no manual hue math, no hand-picked hex values.
+
+```ts
+import { triadic, colorShades } from 'color-value-tools'
+
+triadic('#6c3483') // ['#6c3483', '#34836c', '#83346c'] — evenly spaced 120°
+
+const shades = colorShades('#6c3483', 9) // light-to-dark HSL scale, 9 steps
+
+// One base color in, a coordinated palette out — no manual hue-rotation
+// math, no hand-picked hex values.
+```
+
 ---
 
 ## Documentation & links

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "color-value-tools",
-  "version": "1.1.10",
+  "version": "1.1.12",
   "description": "Parse, convert and manipulate colors across hex, RGB, HSL, Lab, LCH, OKLCH and CMYK, with WCAG contrast checks and CSS variables. Zero dependencies.",
   "author": "macrulez <macrulezru@gmail.com> (https://macrulez.ru/en)",
   "license": "MIT",