Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Ivan Buryak committed Oct 5, 2023
1 parent 42a4404 commit 356f58e
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
# Harmony: Accessible UI Color Palette

The
[Harmony palette](https://www.figma.com/community/file/1287828769207775946/harmony-accessible-ui-color-palette)
The [Harmony palette](https://www.figma.com/community/file/1287828769207775946/harmony-accessible-ui-color-palette)
is designed to elevate control over color contrast in your design system. With
the OKLCH color space and the innovative APCA contrast algorithm, Harmony offers
highly consistent color shades, previously unavailable P3 gamut colors, and
precise control over text and UI element contrast.

<img src="https://cdn.evilmartians.com/badges/logo-no-label.svg" alt="" width="22" height="16" /> Made by Evil Martians, product consulting for developer tools.

## Features
- Equal contrast within lightness groups
- Mirrored contrast pairs
- Contrast levels for readability
- Tailwind compatibility
- P3 gamut for maximum color

## Installation

```shell
Expand All @@ -30,7 +38,7 @@ export default {
};
```

> ⚠️ Harmony uses `oklch` colors and so requires a polyfill
> ⚠️ Harmony uses `oklch` colors and so requires a polyfill for old browsers
1. Install PostCSS plugin that polyfills oklch colors

Expand Down

0 comments on commit 356f58e

Please sign in to comment.