Create README.md

bartbergmans · Feb 20, 2022 · ac1291d · ac1291d
1 parent 548d230
commit ac1291d
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,20 @@
+# Palettey
+
+Package to generate a 10-color palette based on a given color hex.
+Useful to generate Tailwind CSS palettes.
+## Usage
+
+```js
+    // Generate a luminance palette
+    palettey.createPalleteFromColor("primary", "#7953e0", {
+      useLightness: false,
+    })
+
+    // Generate a lightness palette
+    palettey.createPalleteFromColor("primary", "#7953e0", {})
+```
+
+Check out [Palette Generator](https://tailwind.simeongriggs.dev) to try the generator online.
+
+## Credits
+Based on [tailwind-css-palette-generator](https://github.com/SimeonGriggs/tailwind-css-palette-generator) created by [Simeon Griggs](https://simeongriggs.dev/)