From cf566dfd269c94efebc8f70bb5427624f326e787 Mon Sep 17 00:00:00 2001 From: Nick Graffis Date: Tue, 23 Mar 2021 22:40:37 -0700 Subject: [PATCH] Update README.md --- README.md | 41 +++++++++++++++++++++++++++++++++++++++-- 1 file changed, 39 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a0fdaed..a311947 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,39 @@ -# tailwind-dracula -A super tiny tailwind plugin that enables the use of the Dracula colour palette. +![](https://img.shields.io/npm/v/tailwind-nord?style=flat) +![](https://img.shields.io/npm/dw/tailwind-nord?style=flat) + +

+ + Logo + + +

Tailwind Nord

+

+ +A super tiny tailwind plugin that enables the use of the [Nord color palette](https://www.nordtheme.com/). + +Made this mainly for myself, as I kept copying the Nord colours over manually. But hopefully it can save someone else 5 mins at the start of a project! + +## Installation + +`npm i tailwind-nord` + +## Usage + + +In your tailwind.config.js: + +```js + plugins: [ + require('tailwind-nord'), + ], +``` + +You now have access to the Nord theme anywhere you would use normal tailwind colours. + +```html +
+

Hello, this is some text

+
+``` + +I've stuck to the colour names set in the Nord documentation to keep things simple. Check that out [here](https://www.nordtheme.com/docs/colors-and-palettes).