colorizr 4.0.1 → 5.0.1

package/README.md

@@ -1,1168 +1,114 @@
-# Colorizr
+<p align="center">
+  <br>
+  <img alt="colorizr logo" src="docs/public/logo.svg" height="120">
+  <br>
+  <br>
+</p>
+<p align="center">
+  <a href="https://www.npmjs.com/package/colorizr"><img src="https://badge.fury.io/js/colorizr.svg" alt="NPM version" /></a>
+  <a href="https://github.com/gilbarbara/colorizr/actions/workflows/ci.yml"><img src="https://github.com/gilbarbara/colorizr/actions/workflows/ci.yml/badge.svg" alt="CI" /></a>
+  <a href="https://sonarcloud.io/summary/new_code?id=gilbarbara_colorizr"><img src="https://sonarcloud.io/api/project_badges/measure?project=gilbarbara_colorizr&metric=alert_status" alt="Quality Gate Status" /></a>
+  <a href="https://sonarcloud.io/summary/new_code?id=gilbarbara_colorizr"><img src="https://sonarcloud.io/api/project_badges/measure?project=gilbarbara_colorizr&metric=coverage" alt="Coverage" /></a>
+</p>
 
-[![NPM version](https://badge.fury.io/js/colorizr.svg)](https://www.npmjs.com/package/colorizr) [![npm bundle size](https://img.shields.io/bundlephobia/minzip/colorizr)](https://bundlephobia.com/result?p=colorizr) [![CI](https://github.com/gilbarbara/colorizr/actions/workflows/ci.yml/badge.svg)](https://github.com/gilbarbara/colorizr/actions/workflows/main.yml) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=gilbarbara_colorizr&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=gilbarbara_colorizr) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=gilbarbara_colorizr&metric=coverage)](https://sonarcloud.io/summary/new_code?id=gilbarbara_colorizr)
+# Colorizr
 
 A modern color library focused on perceptual correctness and accessibility.
 
-## Highlights
-
 - 🏖 **Easy to use**: Works with Hex, HSL, RGB, OKLAB, and OKLCH.
-- ♿️ **Accessibility**: WCAG 2.x contrast and **APCA (WCAG 3.0)** support.
+- ♿️ **Accessibility**: WCAG 2.x contrast and APCA (WCAG 3.0) support.
 - 🎨 **Design Systems**: Generate perceptual color scales with variants.
 - 🖥 **Modern Displays**: P3 gamut optimization and OkLCH operations.
 - 🟦 **TypeScript**: Full type safety, zero dependencies.
 
-## Setup
+📖 **[Official Website](https://gilbarbara.github.io/colorizr)**
 
-**Install**
+## Setup
 
 ```bash
 npm i colorizr
 ```
 
-## Usage
-
-You can use the functions standalone or compose them freely:
-
-```typescript
-import { scale, readableColor } from 'colorizr';
-
-const swatches = scale('#ff0044');
-
-const accessibleSwatches = Object.entries(swatches).map(
-  ([key, color]) => ({
-    key,
-    color,
-    text: readableColor(color),
-  }),
-);
-```
-
-Or you can create an instance to use all the methods for the same color:
-
-```typescript
-import Colorizr from 'colorizr';
-
-const colorInstance = new Colorizr('#ff0044');
-colorInstance.luminance; // 0.2168
-colorInstance.chroma; // 1
-colorInstance.opacity; // 1
-```
-
-## API
-
-> String inputs accept css values: hex, hsl, oklab, oklch, rgb, and named colors.
-
-- [Info](#Info) – basic color properties and metadata
-- [Manipulators](#Manipulators) – adjust lightness, saturation, hue, alpha
-- [Converters](#Converters) – between color spaces
-- [Generators](#Generators)  – palettes, schemes, scales
-- [Comparison](#Comparison) – WCAG & APCA
-- [Utilities](#Utilities) – helpers for parsing, formatting, random colors
-- [Validators](#Validators) – type and format validation
-- [Class](#Class) – object-oriented API for a single color
-
-### Info
-
-**chroma(input: string): number**  
-Get the chroma of a color.
-
-```typescript
-import { chroma } from 'colorizr';
-
-chroma('#ff0044'); // 1
-chroma('#ffc0cb'); // 0.2471
-```
-
-**luminance(input: string): number**  
-Get the relative brightness according to the [WCAG definition](https://www.w3.org/TR/2008/REC-WCAG20-20081211/#relativeluminancedef).  
-Normalized to `0` for black and `1` for white.
-
-```typescript
-import { luminance } from 'colorizr';
-
-luminance('#ff0044'); // 0.2168
-```
-
-**name(input: string): string**  
-Get the name of a color. Return the hex code if it can't be named.
-
-```typescript
-import { name } from 'colorizr';
-
-name('#ffc0cb'); // pink
-name('rgb(176 224 230)'); // 'powderblue'
-name('hsl(344 100 50)'); // #ff0044
-```
-
-**opacity(input: string): number**  
-Get the opacity of a color.
-
-```typescript
-import { opacity } from 'colorizr';
-
-opacity('#ff0044'); // 1
-opacity('rgb(255 0 68 / 90%)'); // 0.9
-opacity('hsl(344 100 50 / 60%)'); // 0.6
-```
-
-### Manipulators
-
-**lighten(input: string, amount: number): string**  
-Get a color with increased lightness.
-
-```typescript
-import { lighten } from 'colorizr';
-
-lighten('#ff0044', 10); // #ff3369
-lighten('hsl(136 100% 50%)', 10); // hsl(136 100% 60%)
-```
-
-**darken(input: string, amount: number): string**  
-Get a color with decreased lightness.
-
-```typescript
-import { darken } from 'colorizr';
-
-darken('#ff0044', 10); // #cc0036
-darken('oklch(47.642% 0.29956 274.93693)', 10); // oklch(40.377% 0.25281 275.46794)
-```
-
-**saturate(input: string, amount: number): string**  
-Get a color with increased saturation.
-
-```typescript
-import { saturate } from 'colorizr';
-
-saturate('#ff0044', 10); // #ff0044 (already at the maximum)
-saturate('pink', 10); // #ffc0cb
-```
-
-**desaturate(input: string, amount: number): string**  
-Get a color with decreased saturation.
-
-```typescript
-import { desaturate } from 'colorizr';
-
-desaturate('#ff0044', 10); // #f20d4a
-desaturate('oklab(70.622% 0.1374 0.14283)', 10); // oklab(69.021% 0.12176 0.13721)
-```
-
-**invert(input: string): string**  
-Invert the color by rotating the hue 180 degrees.
-
-```typescript
-import { invert } from 'colorizr';
-
-invert('#07e'); // '#ee7700'
-invert('#f058'); // '#00ffaa'
-```
-
-**rotate(input: string, degrees: number): string**  
-Get a color with a hue rotated by the specified degrees.
-
-```typescript
-import { rotate } from 'colorizr';
-
-rotate('#ff0044', 30); // #ff3b00
-```
-
-**opacify(input: string, alpha: number, format?: ColorType): string**  
-Add opacity to a color
-
-```typescript
-import { opacify } from 'colorizr';
-
-opacify('hsl(344 100% 50%)', 0.9); // hsl(344 100% 50% / 90%)
-opacify('#ff0044', 0.8); // #ff0044cc
-```
-
-**transparentize(input: string, alpha: number, format?: ColorType): string**  
-Increase/decrease the color opacity. The alpha range is -1 to 1 (positive decreases opacity, negative increases it).
-
-```typescript
-import { transparentize } from 'colorizr';
-
-transparentize('hsl(344 100% 50%)', 0.1); // hsl(344 100% 50% / 90%)
-transparentize('#ff0044', 0.5); // #ff004480
-transparentize('#ff004480', -0.2); // #ff0044b3 (increases opacity)
-```
-
-**grayscale(input: string, format?: ColorType): string**  
-Convert a color to grayscale using OkLCH (perceptually uniform).
-
-```typescript
-import { grayscale } from 'colorizr';
-
-grayscale('#ff0044'); // '#8a8a8a'
-grayscale('hsl(180, 50%, 50%)'); // 'hsl(0 0% 66.67%)'
-grayscale('#ff0000', 'oklch'); // 'oklch(62.796% 0 29.23494)'
-```
-
-**mix(color1: string, color2: string, ratio?: number, format?: ColorType): string**  
-Mix two colors in OkLCH space with shortest-path hue interpolation.
-
-```typescript
-import { mix } from 'colorizr';
-
-mix('#ff0000', '#0000ff'); // '#ba00c2' (50% mix)
-mix('#ff0000', '#0000ff', 0.25); // '#e8007b'
-mix('#000000', '#ffffff', 0.5); // '#636363'
-mix('hsl(0, 100%, 50%)', '#0000ff', 0.5); // 'hsl(297.53 100% 38.04%)'
-```
-
-### Comparison
-
-**brightnessDifference(left: string, right: string): number**  
-Get the brightness difference between the two colors.
-
-```typescript
-import { brightnessDifference } from 'colorizr';
-
-brightnessDifference('#fff', 'rgb(255, 0, 68)'); // 171.003
-```
+## Generating Scales & Palettes
 
-**colorDifference(left: string, right: string): number**  
-Get the color difference between the two colors.
+Build design system color scales with customizable variants:
 
 ```typescript
-import { colorDifference } from 'colorizr';
-
-colorDifference('hsl(0 0% 100%)', '#f04'); // 442
-```
-
-**compare(left: string, right: string): Analysis**  
-Get the WCAG analysis between two colors.
-
-```typescript
-import { compare } from 'colorizr';
-
-compare('#ff0044', '#fff');
-
-({
-  "brightnessDifference": 171.003,
-  "colorDifference": 442,
-  "compliant": 1,
-  "contrast": 3.94,
-  "largeAA": true,
-  "largeAAA": false,
-  "normalAA": false,
-  "normalAAA": false,
-})
-```
-
-**contrast(left: string, right: string): number**  
-Get the WCAG contrast ratio between two colors.
-
-```typescript
-import { contrast } from 'colorizr';
-
-contrast('hsl(0 0% 100%)', 'rgb(255 0 68)'); // 3.94
-```
-
-### Generators
-
-**palette(input: string, options?: PaletteOptions): string[]**  
-Generate a palette of colors.
+import { scale, palette, scheme } from 'colorizr';
 
-<details>
-  <summary>Type Definition</summary>
-
-  ```typescript
-interface PaletteOptions {
-	/**
-	 * Output color format.
-	 *
-	 * If not specified, the output will use the same format as the input color.
-	 */
-	format?: ColorType;
-	/**
-	 * Adjusts the lightness of the base color before generating the palette.
-	 *
-	 * Value should be between 0 and 100.
-	 */
-	lightness?: number;
-	/**
-	 * Adjusts the saturation of the base color before generating the palette.
-	 *
-	 * Value should be between 0 and 100.
-	 */
-	saturation?: number;
-	/**
-	 * The number of colors to generate in the palette.
-	 *
-	 * Minimum value is 2.
-	 * @default 6
-	 */
-	size?: number;
-	/**
-	 * Generate a monochromatic palette.
-	 *
-	 * For more options, use the `scale` function.
-	 */
-	type?: 'monochromatic';
-}
-  ```
-</details>
-
-```typescript
-import { palette } from 'colorizr';
+scale('#3366ff');
+// { 50: '#f0f5ff', 100: '#e4edff', ..., 900: '#06009a', 950: '#020052' }
 
 palette('#ff0044');
-// ['#ff0044', '#ff7700', '#88ff00', '#00ff77', '#0088ff', '#7700ff'];
-
-palette('#ff0044', { type: 'monochromatic' });
-// ['#ff99b4', '#ff5582', '#ff1150', '#cc0036', '#880024', '#440012']
-```
-
-**scheme(input: string, type: SchemeOptions): string[]**  
-Get a color scheme.
-
-<details>
-  <summary>Type Definition</summary>
-
-  ```typescript
-interface SchemeOptions {
-	/**
-	 * Output color format.
-	 *
-	 * If not specified, the output will use the same format as the input color.
-	 */
-	format?: ColorType;
-	/**
-	 * The type of scheme to generate.
-	 * @default 'complementary'
-	 */
-	type?: Scheme;
-}
-  ```
-</details>
-
-```typescript
-import { scheme } from 'colorizr';
-
-const complementary = scheme('rgb(255 0 68)'); // ['rgb(255 0 68)', 'rgb(0 255 187)']
-const triadic = scheme('#ff0044', 'triadic'); // ['#ff0044', '#44ff00', '#0044ff']
-```
-
-**scale(input: string, options?: ScaleOptions): Record<number, string>**  
-Generate a perceptual color scale with advanced options.
-
-<details>
-  <summary>Type Definition</summary>
-
-  ```typescript
-interface ScaleOptions {
-	/**
-	 * Controls chroma adjustment across lightness levels.
-	 * Values between 0-1 interpolate between these behaviors.
-	 *
-	 * @default 0
-	 */
-	chromaCurve?: number;
-	/**
-	 * Output color format.
-	 *
-	 * Determines the format of the generated colors (e.g., HEX, RGB, OKLCH, etc.).
-	 *
-	 * If not specified, the output will match the format of the input color.
-	 */
-	format?: ColorType;
-	/**
-	 * The lightness tuning factor for the scale.
-	 * - 1: Linear lightness distribution.
-	 * - >1: Lighter tones are emphasized.
-	 * - <1: Darker tones are emphasized.
-	 * @default 1.5
-	 */
-	lightnessCurve?: number;
-	/**
-	 * Lock input color at specific step position.
-	 *
-	 * The input color will appear exactly at this step, and other steps
-	 * will be calculated relative to this anchor point.
-	 *
-	 * Must be a valid key for the current step count.
-	 */
-	lock?: number;
-	/**
-	 * The maximum lightness value for the scale.
-	 *
-	 * Defines the upper bound for the lightest color in the palette.
-	 *
-	 * A number between 0 and 1.
-	 * @default 0.97
-	 */
-	maxLightness?: number;
-	/**
-	 * The minimum lightness value for the scale.
-	 *
-	 * Defines the lower bound for the darkest color in the palette.
-	 *
-	 * A number between 0 and 1.
-	 *
-	 * @default 0.2
-	 */
-	minLightness?: number;
-	/**
-	 * Theme-aware lightness direction.
-	 *
-	 * - 'light': Low keys (50) are lightest, high keys (950) are darkest
-	 * - 'dark': Low keys (50) are darkest, high keys (950) are lightest
-	 *
-	 * @default 'light'
-	 */
-	mode?: ScaleMode;
-	/**
-	 * Global saturation override (0-100).
-	 *
-	 * When set, overrides the chroma for all generated shades.
-	 * Maps to chroma in OKLCH space.
-	 *
-	 * Overrides `variant` if both are set.
-	 */
-	saturation?: number;
-	/**
-	 * Number of steps in the scale (3-20).
-	 *
-	 * Controls how many color shades are generated.
-	 *
-	 * @default 11
-	 */
-	steps?: number;
-	/**
-	 * The variant of the scale.
-	 * - 'deep': Generates rich and bold tones with significantly reduced lightness.
-	 * - 'neutral': Generates muted tones by reducing chroma.
-	 * - 'pastel': Produces soft and airy tones with significant chroma reduction.
-	 * - 'subtle': Creates extremely desaturated tones, close to grayscale.
-	 * - 'vibrant': Enhances chroma for bold and striking tones.
-	 */
-	variant?: ScaleVariant;
-}
-  ```
-</details>
-
-```typescript
-import { scale } from 'colorizr';
-
-scale('#ff0044');
-/*
-{
-  50: '#ffeeed',
-  100: '#ffe0df',
-  200: '#ffc7c6',
-  300: '#ffa7a7',
-  400: '#ff8186',
-  500: '#ff5464',
-  600: '#f20f42',
-  700: '#d40021',
-  800: '#ad0000',
-  900: '#7d0000',
-  950: '#470000'
-}
-*/
-
-scale(
-  '#ff0044',
-  { lightnessCurve: 1.6, lock: 500, steps: 10, format: 'oklch' },
-);
-/*
-{
-  50: 'oklch(97% 0.25404 19.90218)',
-  100: 'oklch(94.432% 0.25404 19.90218)',
-  200: 'oklch(89.214% 0.25404 19.90218)',
-  300: 'oklch(82.104% 0.25404 19.90218)',
-  400: 'oklch(73.397% 0.25404 19.90218)',
-  500: 'oklch(63.269% 0.25404 19.90218)',
-  600: 'oklch(58.561% 0.25404 19.90218)',
-  700: 'oklch(48.996% 0.25404 19.90218)',
-  800: 'oklch(35.962% 0.25404 19.90218)',
-  900: 'oklch(20% 0.25404 19.90218)'
-}
-*/
-```
-
-**getScaleStepKeys(steps: number): number[]**  
-Get the step keys for a given step count (3-20).
-
-```typescript
-import { getScaleStepKeys } from 'colorizr';
-
-getScaleStepKeys(3);  // [100, 500, 900]
-getScaleStepKeys(5);  // [100, 300, 500, 700, 900]
-getScaleStepKeys(11); // [50, 100, 200, 300, 400, 500, 600, 700, 800, 900, 950]
-```
-
-### Converters
-
-The default precision is 5.
-
-**convert(input: string, format: ColorType): string**  
-Convert a color string to another format.
-
-```typescript
-import { convert } from 'colorizr';
-
-convert('#ff0044', 'hsl') // hsl(344 100% 50%)
-convert('rgb(255 0 68)', 'oklch') // oklch(63.269% 0.25404 19.90218)
-```
-
-**hex2hsl(input: string): HSL**  
-Convert HEX to HSL.
-
-```typescript
-import { hex2hsl } from 'colorizr';
-
-hex2hsl('#ff0044'); // { h: 344, s: 100, l: 50 }
-```
-
-**hex2oklab(input: string, precision?: number): LAB**  
-Convert HEX to OKLAB.
-
-```typescript
-import { hex2oklab } from 'colorizr';
-
-hex2oklab('#ff0044'); // { l: 0.63269, a: 0.23887, b: 0.08648 }
-```
-
-**hex2oklch(input: string, precision?: number): LCH**  
-Convert HEX to OKLCH.
-
-```typescript
-import { hex2oklch } from 'colorizr';
-
-hex2oklch('#ff0044'); // { l: 0.63269, c: 0.25404, h: 19.90218 }
-```
-
-**hex2rgb(input: string): RGB**  
-Convert HEX to RGB.
-
-```typescript
-import { hex2rgb } from 'colorizr';
-
-hex2rgb('#ff0044'); // { r: 255, g: 0, b: 68 }
-```
-
-**hsl2hex(input: HSL | ColorTuple): string**  
-Convert HSL to HEX.
-
-```typescript
-import { hsl2hex } from 'colorizr';
-
-hsl2hex({ h: 344, s: 100, l: 50 }); // '#ff0044'
-hsl2hex([344, 100, 50]); // '#ff0044'
-```
-
-**hsl2oklab(input: HSL | ColorTuple, precision?: number): LAB**  
-Convert HSL to OKLAB.
-
-```typescript
-import { hsl2oklab } from 'colorizr';
-
-hsl2oklab({ h: 344, s: 100, l: 50 }); // { l: 0.63269, a: 0.23887, b: 0.08648 }
-hsl2oklab([344, 100, 50]); // { l: 0.63269, a: 0.23887, b: 0.08648 }
-```
-
-**hsl2oklch(input: HSL | ColorTuple, precision?: number): LCH**  
-Convert HSL to OKLCH.
-
-```typescript
-import { hsl2oklch } from 'colorizr';
-
-hsl2oklch({ h: 344, s: 100, l: 50 }); // { l: 0.63269, c: 0.25404, h: 19.90218 }
-hsl2oklch([344, 100, 50]); // { l: 0.63269, c: 0.25404, h: 19.90218 }
-```
+// ['#ff0044', '#ffbb00', '#44ff00', '#00ffbb', '#0044ff', '#bb00ff']
 
-**hsl2rgb(input: HSL | ColorTuple): RGB**  
-Convert HSL to RGB.
-
-```typescript
-import { hsl2rgb } from 'colorizr';
-
-hsl2rgb({ h: 344, s: 100, l: 50 }); // { r: 255, g: 0, b: 68 }
-hsl2rgb([344, 100, 50]); // { r: 255, g: 0, b: 68 }
-```
-
-**oklab2hex(input: LAB | ColorTuple): string**  
-Convert OKLAB to HEX.
-
-```typescript
-import { oklab2hex } from 'colorizr';
-
-oklab2hex({ l: 0.63269, a: 0.23887, b: 0.08648 }); // '#ff0044'
-oklab2hex([0.63269, 0.23887, 0.08648]); // '#ff0044'
-```
-
-**oklab2hsl(input: LAB | ColorTuple): HSL**  
-Convert OKLAB to HSL.
-
-```typescript
-import { oklab2hsl } from 'colorizr';
-
-oklab2hsl({ l: 0.63269, a: 0.23887, b: 0.08648 }); // { h: 344, s: 100, l: 50 }
-oklab2hsl([0.63269, 0.23887, 0.08648]); // { h: 344, s: 100, l: 50 }
-```
-
-**oklab2oklch(input: LAB | ColorTuple, precision?: number): LCH**  
-Convert OKLAB to OKLCH.
-
-```typescript
-import { oklab2oklch } from 'colorizr';
-
-oklab2oklch({ l: 0.63269, a: 0.23887, b: 0.08648 }); // { l: 0.63269, c: 0.25404, h: 19.90218 }
-oklab2oklch([0.63269, 0.23887, 0.08648]); // { l: 0.63269, c: 0.25404, h: 19.90218 }
-```
-
-**oklab2rgb(input: LAB | ColorTuple, precision: number = 0): RGB**  
-Convert OKLAB to RGB.
-
-```typescript
-import { oklab2rgb } from 'colorizr';
-
-oklab2rgb({ l: 0.63269, a: 0.23887, b: 0.08648 }); // { r: 255, g: 0, b: 68 }
-oklab2rgb([0.63269, 0.23887, 0.08648]); // { r: 255, g: 0, b: 68 }
-```
-
-**oklch2hex(input: LCH | ColorTuple): string**  
-Convert OKLCH to HEX.
-
-```typescript
-import { oklch2hex } from 'colorizr';
-
-oklch2hex({ l: 0.63269, c: 0.25404, h: 19.90218 }); // '#ff0044'
-oklch2hex([0.63269, 0.25404, 19.90218]); // '#ff0044'
-```
-
-**oklch2hsl(input: LCH | ColorTuple): HSL**  
-Convert OKLCH to HSL.
-
-```typescript
-import { oklch2hsl } from 'colorizr';
-
-oklch2hsl({ l: 0.63269, c: 0.25404, h: 19.90218 }); // { h: 344, s: 100, l: 50 }
-oklch2hsl([0.63269, 0.25404, 19.90218]); // { h: 344, s: 100, l: 50 }
-```
-
-**oklch2oklab(input: LCH | ColorTuple, precision?: number): LAB**  
-Convert OKLCH to OKLAB.
-
-```typescript
-import { oklch2oklab } from 'colorizr';
-
-oklch2oklab({ l: 0.63269, c: 0.25404, h: 19.90218 }); // { l: 0.63269, a: 0.23887, b: 0.08648 }
-oklch2oklab([0.63269, 0.25404, 19.90218]); // { l: 0.63269, a: 0.23887, b: 0.08648 }
-```
-
-**oklch2rgb(input: LCH | ColorTuple, precision: number = 0): RGB**  
-Convert OKLCH to RGB.
-
-```typescript
-import { oklch2rgb } from 'colorizr';
-
-oklch2rgb({ l: 0.63269, c: 0.25404, h: 19.90218 }); // { r: 255, g: 0, b: 68 }
-oklch2rgb([0.63269, 0.25404, 19.90218]); // { r: 255, g: 0, b: 68 }
-```
-
-**rgb2hex(input: RGB | ColorTuple): string**  
-Convert RGB to HEX.
-
-```typescript
-import { rgb2hex } from 'colorizr';
-
-rgb2hex({ r: 255, g: 0, b: 68 }); // '#ff0044'
-rgb2hex([255, 0, 68]); // '#ff0044'
-```
-
-**rgb2hsl(input: RGB | ColorTuple): HSL**  
-Convert RGB to HSL.
-
-```typescript
-import { rgb2hsl } from 'colorizr';
-
-rgb2hsl({ r: 255, g: 0, b: 68 }); // { h: 344, s: 100, l: 50 }
-rgb2hsl([255, 0, 68]); // { h: 344, s: 100, l: 50 }
-```
-
-**rgb2oklab(input: RGB | ColorTuple, precision?: number): LAB**  
-Convert RGB to OKLAB.
-
-```typescript
-import { rgb2oklab } from 'colorizr';
-
-rgb2oklab({ r: 255, g: 0, b: 68 }); // { l: 0.63269, a: 0.23887, b: 0.08648 }
-rgb2oklab([255, 0, 68]); // { l: 0.63269, a: 0.23887, b: 0.08648 }
-```
-
-**rgb2oklch(input: RGB | ColorTuple, precision?: number): LCH**  
-Convert RGB to OKLCH.
-
-```typescript
-import { rgb2oklch } from 'colorizr';
-
-rgb2oklch({ r: 255, g: 0, b: 68 }); // { l: 0.63269, c: 0.25404, h: 19.90218 }
-rgb2oklch([255, 0, 68]); // { l: 0.63269, c: 0.25404, h: 19.90218 }
-```
-
-### Utilities
-
-**addAlphaToHex(input: string, alpha: number): string**  
-Add an alpha value to a hex string
-
-```typescript
-import { addAlphaToHex } from 'colorizr';
-
-addAlphaToHex('#ff0044', 0.9); // '#ff0044e6'
-addAlphaToHex('#ff0044cc', 0.9); // '#ff0044e6'
-```
-
-**apcaContrast(background: string, foreground: string): number**  
-Calculate APCA contrast between two colors. APCA (Accessible Perceptual Contrast Algorithm) is the contrast method proposed for WCAG 3.0.
-
-Returns the Lc (Lightness contrast) value:
-- Positive values indicate dark text on light background
-- Negative values indicate light text on dark background
-
-```typescript
-import { apcaContrast } from 'colorizr';
-
-apcaContrast('#ffffff', '#000000'); // 106.04 (black text on white bg)
-apcaContrast('#000000', '#ffffff'); // -107.88 (white text on black bg)
-apcaContrast('#888888', '#ffffff'); // -68.54 (white text on gray bg)
-```
-
-**convertAlphaToHex(input: number): string**  
-Convert an alpha value to a hex value.
-
-```typescript
-import { convertAlphaToHex } from 'colorizr';
-
-convertAlphaToHex(0.5); // '80'
-```
-
-**extractAlphaFromHex(input: string): number**  
-Extract the alpha value from a hex string
-
-```typescript
-import { extractAlphaFromHex } from 'colorizr';
-
-extractAlphaFromHex('#ff004480'); // 0.5
-```
-
-**extractColorParts(input: string): ExtractColorPartsReturn**  
-Extract the color parts from a CSS color string.
-Hex colors are not supported.
-
-```typescript
-type ExtractColorPartsReturn = {
-  alpha?: number;
-  model: 'hsl' | 'oklab' | 'oklch' | 'rgb';
-} & Record<string, number>;
-
-extractColorParts('rgb(255 0 68)') // { model: 'rgb', r: 255, g: 0, b: 68 }
-extractColorParts('hsl(344 100% 50% / 90%)') // { alpha: 0.9, model: 'hsl', h: 344, s: 100, l: 50 }
+scheme('#ff0044', 'triadic');
+// ['#ff0044', '#44ff00', '#0044ff']
 ```
 
-**formatCSS(input: HSL | RGB, options?: FormatCSSOptions): string**  
-Get a CSS string from a color object.
+## Accessibility & Contrast
 
-<details>
-  <summary>Type Definition</summary>
-
-  ```typescript
-interface FormatCSSOptions {
-	/**
-	 * The alpha value of the color (0-1).
-	 */
-	alpha?: number;
-	/**
-	 * Output color format.
-	 * @default 'hex'
-	 */
-	format?: ColorType;
-	/**
-	 * The number of digits of the output.
-	 * @default 5
-	 */
-	precision?: number;
-	/**
-	 * The separator between the values.
-	 *
-	 * oklab and oklch always use space as a separator.
-	 * @default ' '
-	 */
-	separator?: string;
-}
-  ```
-</details>
-
-```typescript
-import { formatCSS } from 'colorizr';
-
-formatCSS({ h: 344, s: 100, l: 50 }, { format: 'rgb' }); // 'rgb(255, 0, 68)'
-formatCSS({ r: 255, g: 0, b: 68 }, { alpha: 0.5, format: 'hsl' }); // 'hsla(344, 100%, 50%, 0.5)'
-```
-
-**formatHex(input: string): string**  
-Format a short hex string of 3 (or 4) digits into 6 (or 8) digits.
-
-```typescript
-import { formatHex } from 'colorizr';
-
-formatHex('#07e'); // '#0077ee'
-formatHex('#f058'); // '#ff005588'
-```
-
-**getColorType(input: string): ColorTypeInput | null**  
-Detect the color type from a CSS color string.
-
-```typescript
-import { getColorType } from 'colorizr';
-
-getColorType('#ff0044'); // 'hex'
-getColorType('red'); // 'named'
-getColorType('hsl(344 100% 50%)'); // 'hsl'
-getColorType('rgb(255 0 68)'); // 'rgb'
-getColorType('oklab(0.63 0.24 0.09)'); // 'oklab'
-getColorType('oklch(0.63 0.25 20)'); // 'oklch'
-getColorType('invalid'); // null
-```
-
-**getOkLCHMaxChroma(input: string | LCH, precision?: number): number**  
-Get the maximum chroma for a given lightness and hue in the OkLCH color space.
-
-```typescript
-import { getOkLCHMaxChroma } from 'colorizr';
-
-getOkLCHMaxChroma({ l: 0.63269, c: 0.25404, h: 19.90218 }); // 0.28643
-getOkLCHMaxChroma('#00ff44'); // 0.30921 
-```
-
-**getP3MaxColor(input: string | LCH): string**  
-Get a OkLCH color with maxed chroma in the P3 color space.
-
-```typescript
-import { getP3MaxColor } from 'colorizr';
-
-getP3MaxColor({ l: 0.63269, c: 0.25404, h: 19.90218 }); // oklch(0.63269 0.28643 19.90218)
-getP3MaxColor('#00ff44'); // oklch(0.86876 0.30921 144.65534) 
-```
-
-**parseCSS(input: string, format?: ColorType): string | HSL | RGB**  
-Parse a css string to hex, HSL, OKLAB, OKLCH, or RGB.  
-If the format isn't set, it will return the same format as the input.
-
-```typescript
-import { parseCSS } from 'colorizr';
-
-parseCSS('hsl(344 100% 50%)'); // { h: 344, l: 50, s: 100 }
-parseCSS('#ff0044', 'hsl'); // { h: 344, l: 50, s: 100 }
-```
-
-**random(options?: RandomOptions): string**  
-Generate a random color.
-
-<details>
-  <summary>Type Definition</summary>
-
-  ```typescript
-interface RandomOptions {
-	/**
-	 * The color format to return.
-	 * @default 'hex'
-	 */
-	format?: ColorType;
-	/**
-	 * Maximum hue value (0-360).
-	 * @default 360
-	 */
-	maxHue?: number;
-	/**
-	 * Maximum lightness value (0-100).
-	 * @default 90
-	 */
-	maxLightness?: number;
-	/**
-	 * Maximum saturation value (0-100).
-	 * @default 100
-	 */
-	maxSaturation?: number;
-	/**
-	 * Minimum hue value (0-360).
-	 * If minHue > maxHue, the range wraps around 0° (e.g., 330-30 for reds).
-	 * @default 0
-	 */
-	minHue?: number;
-	/**
-	 * Minimum lightness value (0-100).
-	 * @default 10
-	 */
-	minLightness?: number;
-	/**
-	 * Minimum saturation value (0-100).
-	 * @default 10
-	 */
-	minSaturation?: number;
-}
-  ```
-</details>
-
-```typescript
-import { random } from 'colorizr';
-
-random(); // '#b385e0'
-random({ format: 'oklch', minLightness: 40 }) // oklch(58.443% 0.2934 306.42895)
-```
-
-**removeAlphaFromHex(input: string): string**  
-Remove the alpha value from a hex string
-
-```typescript
-import { removeAlphaFromHex } from 'colorizr';
-
-removeAlphaFromHex('#ff0044cc'); // '#ff0044'
-```
-
-**readableColor(backgroundColor: string, options?: ReadableColorOptions): string**  
-Get the most readable color (light or dark) for a given background.
-
-<details>
-  <summary>Type Definition</summary>
-
-  ```typescript
-interface ReadableColorOptions {
-	/**
-	 * The dark color to return if the background is light.
-	 * @default '#000000'
-	 */
-	darkColor?: string;
-	/**
-	 * The light color to return if the background is dark.
-	 * @default '#ffffff'
-	 */
-	lightColor?: string;
-	/**
-	 * The method to use for determining contrast.
-	 *
-	 * - `yiq`: YIQ brightness formula (fast, simple)
-	 * - `wcag`: WCAG 2.x relative luminance threshold
-	 * - `contrast`: WCAG 2.x contrast ratio comparison
-	 * - `oklab`: OkLab perceptual lightness threshold
-	 * - `apca`: APCA contrast comparison (WCAG 3.0 candidate)
-	 *
-	 * @default 'yiq'
-	 */
-	method?: ReadableColorMethod;
-	/**
-	 * The threshold for threshold-based methods.
-	 *
-	 * - `yiq`: 0-255 (default: 128)
-	 * - `wcag`: 0-1 (default: 0.5)
-	 * - `oklab`: 0-1 (default: 0.5)
-	 * - `contrast` and `apca`: ignored (comparison-based)
-	 */
-	threshold?: number;
-}
-  ```
-</details>
+Analyze contrast ratios and find readable text colors:
 
 ```typescript
-import { readableColor } from 'colorizr';
+import { contrast, readableColor, compare, apcaContrast } from 'colorizr';
 
-readableColor('#ff0044'); // '#ffffff' (using yiq)
-readableColor('#fff800'); // '#000000'
+contrast('#1a1a2e', '#ffffff'); // 17.05
+readableColor('#ff0044'); // '#ffffff'
+apcaContrast('#000000', '#ffffff'); // 106.04067
 
-// Using different methods
-readableColor('#808080', { method: 'wcag' }); // '#ffffff'
-readableColor('#808080', { method: 'contrast' }); // '#000000'
-readableColor('#808080', { method: 'apca' }); // '#ffffff'
-
-// Custom colors and threshold
-readableColor('#ff0044', {
-  darkColor: '#111',
-  lightColor: '#eee',
-  threshold: 150  // for yiq method (0-255)
-});
-
-readableColor('#ff0044', {
-  method: 'wcag',
-  threshold: 0.4  // for wcag/oklab methods (0-1)
-});
-```
-
-**readableColorAPCA(backgroundColor: string, options?: ReadableColorAPCAOptions): string**  
-Get the most readable color using APCA contrast. Standalone function for APCA method.
-
-<details>
-  <summary>Type Definition</summary>
-
-  ```typescript
-interface ReadableColorAPCAOptions {
-	/**
-	 * The dark color to return if it has better contrast.
-	 * @default '#000000'
-	 */
-	darkColor?: string;
-	/**
-	 * The light color to return if it has better contrast.
-	 * @default '#ffffff'
-	 */
-	lightColor?: string;
-}
-  ```
-</details>
-
-```typescript
-import { readableColorAPCA } from 'colorizr';
-
-readableColorAPCA('#ffffff'); // '#000000'
-readableColorAPCA('#000000'); // '#ffffff'
-readableColorAPCA('#888888'); // '#ffffff' (APCA favors light text on mid-grays)
+compare('#ff0044', '#ffffff');
+// { contrast: 3.94, normalAA: false, largeAA: true, ... }
 ```
 
-### Validators
+## Manipulating Colors
 
-**isValidColor(input: string, type?: ColorTypeInput): boolean**  
-Check if the input is a valid color. Optionally validate against a specific color type.
+Adjust lightness, saturation, hue, and opacity:
 
 ```typescript
-import { isValidColor } from 'colorizr';
+import { lighten, darken, saturate, mix, rotate } from 'colorizr';
 
-isValidColor('#ff0044'); // true
-isValidColor('#ff004400'); // true
-isValidColor('hsl(136 100% 50%)'); // true
-isValidColor('hsla(344, 100%, 50%, 0.4)'); // true
-isValidColor('oklab(70.622% 0.1374 0.14283)'); // true
-isValidColor('oklch(47.642% 0.29956 274.93693)'); // true
-isValidColor('rgb(255 230 109)'); // true
-isValidColor('blue'); // true
-isValidColor('aliceblue'); // true
-isValidColor('#mmff00'); // false
-isValidColor('blue-ish'); // false
+lighten('#ff0044', 20); // '#ff668f'
+darken('#ff0044', 10);  // '#cc0036'
+rotate('#ff0044', 180); // '#00ffbb'
 
-// With type validation
-isValidColor('#ff0044', 'hex'); // true
-isValidColor('#ff0044', 'hsl'); // false
-isValidColor('hsl(0 100% 50%)', 'hsl'); // true
-isValidColor('blue', 'named'); // true
-isValidColor('blue', 'hex'); // false
+mix('#ff0044', '#0066ff');                         // '#bc34d7'
+mix('#ff0044', '#0066ff', 0.5, { space: 'hsl' });  // '#aa00ff'
 ```
 
-**isHex(input: unknown): boolean**  
-Check if the input is a valid hex color.
+## Converting Colors
 
-```typescript
-import { isHex } from 'colorizr';
-
-isHex('#f04'); // true
-isHex('#ff0044'); // true
-isHex('#ff0044cc'); // true
-```
-
-**isHSL(input: unknown): boolean**  
-Check if the input is a valid HSL object.
+Convert between all supported color spaces:
 
 ```typescript
-import { isHSL } from 'colorizr';
-
-isHSL({ h: 344, s: 100, l: 50 }); // true
-```
+import { convertCSS, hex2oklch, parseCSS } from 'colorizr';
 
-**isLAB(input: unknown): boolean**  
-Check if the input is a valid LAB color.
+convertCSS('#ff0044', 'oklch'); // 'oklch(63.269% 0.25404 19.902)'
+convertCSS('#ff0044', 'hsl');   // 'hsl(344 100% 50%)'
 
-```typescript
-import { isLAB } from 'colorizr';
+hex2oklch('#ff0044');
+// { l: 0.63269, c: 0.25404, h: 19.90224 }
 
-isLAB({ l: 0.63269, a: 0.23887, b: 0.08648 }); // true
+parseCSS('hsl(344 100% 50%)');
+// { h: 344, s: 100, l: 50 }
 ```
 
-**isLCH(input: unknown): boolean**  
-Check if the input is a valid LCH color.
+## Class API
 
-```typescript
-import { isLCH } from 'colorizr';
-
-isLCH({ l: 0.63269, c: 0.25404, h: 19.90218 }); // true
-```
-
-**isRGB(input: unknown): boolean**  
-Check if the input is a valid RGB color.
-
-```typescript
-import { isRGB } from 'colorizr';
-
-isRGB({ r: 255, g: 0, b: 68 }); // true
-```
-
-### Class
+Create an instance to work with a single color:
 
 ```typescript
 import Colorizr from 'colorizr';
 
-const colorizr = new Colorizr('#ff0044');
-
-colorizr.hex; // #ff0044
-colorizr.hsl; // { h: 344, s: 100, l: 50 };
-colorizr.rgb; // { r: 255, g: 0, b: 68 };
+const color = new Colorizr('#ff0044');
+color.luminance;      // 0.2168
+color.chroma;         // 1
+color.readableColor;  // '#ffffff'
+color.lighten(20);    // '#ff668f'
+color.mix('#0066ff'); // '#bc34d7'
 ```
 
-#### Getters
-
-**colorizr.hex**  
-Get the hex code.
-
-**colorizr.hsl**  
-Get the HSL object.
-
-**colorizr.oklab**  
-Get the OKLAB object.
-
-**colorizr.oklch**  
-Get the OKLCH object.
-
-**colorizr.rgb**  
-Get the RGB object.
-
-**colorizr.hue**  
-Get the hue (0-360).
-
-**colorizr.saturation**  
-Get the saturation (0-100).
-
-**colorizr.lightness**  
-Get the lightness (0-100).
-
-**colorizr.red**  
-Get the red level (0-255).
-
-**colorizr.green**  
-Get the green level (0-255).
-
-**colorizr.blue**  
-Get the blue level (0-255).
-
-**colorizr.chroma**  
-Get the chroma (0-1).
-
-**colorizr.luminance**  
-Get the luminance (0-1).
-
-**colorizr.opacity**  
-Get the opacity (0-1).
-
-**colorizr.css**  
-Get the css string of the same type as the input.
-
-**colorizr.readableColor**  
-Get the most readable color (black or white) for this color as a background.
-
-#### Methods
-
-**colorizr.format(type: ColorType, precision?: number)**  
-Returns the formatted color in the specified format.
-
-The class also includes all [Manipulators](#Manipulators) (`lighten`, `darken`, `saturate`, `desaturate`, `invert`, `rotate`, `opacify`, `transparentize`, `grayscale`, `mix`) and [Comparison](#Comparison) methods (`contrast`, `brightnessDifference`, `colorDifference`, `compare`).
+📖 **[Read the full documentation](https://gilbarbara.github.io/colorizr)**
 
 ## Credits / References