Update README.md

README.md

@@ -1,4 +1,4 @@
-![NPM Version](https://img.shields.io/npm/v/%40alexaka1%2Ftailwindcss-oklch)
+[![NPM Version](https://img.shields.io/npm/v/%40alexaka1%2Ftailwindcss-oklch)](https://www.npmjs.com/package/@alexaka1/tailwindcss-oklch)
 
 # Tailwind OKLCH
 

src/tailwindcss-oklch/README.md

@@ -0,0 +1,139 @@
+[![NPM Version](https://img.shields.io/npm/v/%40alexaka1%2Ftailwindcss-oklch)](https://www.npmjs.com/package/@alexaka1/tailwindcss-oklch)
+
+# Tailwind OKLCH
+
+view on: [npm](https://www.npmjs.com/package/@alexaka1/tailwindcss-oklch) - [GitHub](https://github.com/alexaka1/tailwindcss-oklch)
+
+This repo was cloned from [Martijn Cuppens's tailwindcss-oklch](https://github.com/MartijnCuppens/tailwindcss-oklch). Special thanks to Martijn for creating this plugin.
+
+Brings OKLCH to Tailwind and introduces these helpful utilities:
+
+- Contrast utilities that automatically calculate the contrast color (black/white) of any color in CSS.
+- Match utilities that will match the color of a property with another property (e.g. outline color matches the background color), with support for opacity modifiers.
+- Lightness offset utilities that darken or lighten colors (e.g. on hover).
+
+You don't need to change your theme colors, since this plugin uses color.js to convert all existing colors.
+
+## Installation
+
+To use this package, install it via npm:
+
+```shell
+npm install tailwindcss-oklch
+```
+
+Then, enable the plugin in your Tailwind config:
+
+```js
+/** @type {import('tailwindcss').Config} */
+module.exports = {
+  plugins: [require('@alexaka1/tailwindcss-oklch')()],
+};
+```
+The plugin returns a function in order to allow you to change the default values.
+
+## Features
+
+### Contrast utilities
+
+The `text-bg-contrast` class added to an element with the `bg-blue-500` class will set the text color to the contrast color (white or black) of the blue button. If the color of the button changes lightness over time, the contrast color will be recalculated in CSS. Opacity modifiers can be added to change the opacity of the color you're setting. Examples:
+
+- `text-bg-contrast` sets the text color to the contrast color of the background color.
+- `text-border-contrast` sets the text color to the contrast color of the border color.
+- `bg-border-contrast` sets the background color to the contrast color of the border color.
+- `text-bg-contrast/50` sets the text color to the contrast color of the background color with an opacity of 50%.
+- `bg-border-contrast/50` sets the background color to the contrast color of the border color with an opacity of 50%.
+
+### Match utilities
+
+The `text-border` class sets the text color to the same color as the border of the element. Other examples:
+
+- `border-text` sets the border color to the text color. The difference with `border-current` is the ability to set opacity or change lightness with additional classes.
+- `border-text/50` sets the border color to the text color with an opacity of 50%.
+
+### Lightness offset
+
+The `text-lightness-offset-10` increases the lightness of the text with 10%. Other examples:
+
+- `hover:-bg-lightness-offset-10` darkens the background on hover with 10%.
+
+## Configuration
+
+If you prefer to change the threshold when the contrast color switches to black or white, you can adjust the value of `contrastThreshold`. This value should be somewhere between `0` and `1`. The higher the number, the more likely white will be chosen as the contrast color. While I was working on this plugin, I noticed that a contrast threshold of `.6` looked better on different screens than `.5`, since dark colors seem to have lesser contrast then lighter colors in reality.
+
+If you're looking for contrast colors beyond just black and white, and you'd like a hint of hue to be present in the contrasting shade, consider modifying the `minContrastLightness` parameter to introduce some color to the darker tones. Simultaneously, you can reduce the `maxContrastLightness` setting to infuse a touch of hue into the lighter shades of white.
+
+Precision was added since color.js uses floats to calculate the OKLCH values, which can result in long numbers. Defaults to `6`.
+
+```js
+/** @type {import('tailwindcss').Config} */
+module.exports = {
+  plugins: [
+    require('@alexaka1/tailwindcss-oklch')({
+      contrastThreshold: 0.5,
+      precision: 8,
+      minContrastLightness: 0,
+      maxContrastLightness: 1,
+    }),
+  ],
+};
+```
+
+## Demo
+
+[View the demo site](https://tailwind-oklch.netlify.app).
+
+## Named colors
+
+In case you prefer named color names, you can add them in your Tailwind config. For example, if you want to use the Bootstrap colors:
+
+```js
+/** @type {import('tailwindcss').Config} */
+module.exports = {
+  theme: {
+    extend: {
+      colors: {
+        primary: '#0d6efd',
+        secondary: '#6c757d',
+        success: '#198754',
+        danger: '#dc3545',
+        warning: '#ffc107',
+        info: '#0dcaf0',
+        light: '#f8f9fa',
+        dark: '#212529',
+      },
+    },
+  },
+};
+```
+
+## Custom properties / CSS variables support
+
+```js
+/** @type {import('tailwindcss').Config} */
+module.exports = {
+  theme: {
+    extend: {
+      colors: {
+        primary: `oklch(var(--color-primary-l) var(--color-primary-c) var(--color-primary-h) / <alpha-value>)`,
+        secondary: `oklch(var(--color-secondary-l) var(--color-secondary-c) var(--color-secondary-h) / <alpha-value>)`,
+        success: `oklch(var(--color-success-l) var(--color-success-c) var(--color-success-h) / <alpha-value>)`,
+        warning: `oklch(var(--color-warning-l) var(--color-warning-c) var(--color-warning-h) / <alpha-value>)`,
+        danger: `oklch(var(--color-danger-l) var(--color-danger-c) var(--color-danger-h) / <alpha-value>)`,
+      },
+    },
+  },
+};
+```
+
+You can later on change the colors without recompiling by setting the LCH values. You can use [oklch.com](https://oklch.com) (web based) or [colorjs.io](https://colorjs.io) (javascript library) to convert colors. Make sure to use decimals instead of percentages for the lightness, since these are needed to calculate contrast colors.
+
+```css
+@layer base {
+  :root {
+    --color-primary-l: 0.32;
+    --color-primary-c: 0.1;
+    --color-primary-h: 150;
+  }
+}
+```