first commit

docs/media/image/colour-convert-hsluv/README.md

@@ -0,0 +1,32 @@
+# @suaveplan/colour-convert-hsluv - HSLuv perceptually uniform colour space: conversions and harmony generators
+
+HSLuv perceptually-uniform colour space with gamut-mapped ray intersection for sRGB. This plugin provides bidirectional RGB↔HSLuv/HPLuv conversions and uniform colour harmonies (complementary, triad, tetrad) that preserve perceptual lightness across hue rotations.
+
+<!-- begin:auto-docs -->
+## Documentation tree
+
+- [colour-convert-hsluv](./src/colour-convert-hsluv/colour-convert-hsluv.md) — `colour-convert-hsluv.ts` implements the HSLuv perceptually uniform colour space. Unlike HSL, which stretches and compr…
+  - [colour-convert-hsluv](./src/colour-convert-hsluv/colour-convert-hsluv.md) — `colour-convert-hsluv.ts` implements the HSLuv perceptually uniform colour space. Unlike HSL, which stretches and compr…
+<!-- end:auto-docs -->
+
+## Installation
+
+```bash
+bun add @suaveplan/colour-convert-hsluv
+```
+
+## Quick Start
+
+```ts
+import { rgbToHsluv, hsluvToRgb, uniformTriad } from "@suaveplan/colour-convert-hsluv";
+
+const hsluv = rgbToHsluv({ r: 255, g: 0, b: 0 });
+console.log(hsluv); // { h: ~12.2, s: ~100, l: ~53.2 }
+
+const colours = uniformTriad({ r: 59, g: 130, b: 246 });
+console.log(colours); // [primary, secondary, tertiary]
+```
+
+## Modules
+
+- [`src/colour-convert-hsluv/colour-convert-hsluv.md`](./src/colour-convert-hsluv/colour-convert-hsluv.md) — HSLuv/HPLuv conversion and uniform harmonies implementation