Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nickgraffis authored Mar 24, 2021
1 parent b3acdb8 commit cf566df
Showing 1 changed file with 39 additions and 2 deletions.
41 changes: 39 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

<p align="center">
<a href="https://github.com/crumb1e/tailwind-nord">
<img src="https://raw.githubusercontent.com/crumb1e/tailwind-nord/master/tailwind-nord.png" alt="Logo">
</a>

<h1 align="center">Tailwind Nord</h1>
</p>

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
<div class="bg-nord0">
<p class="text-nord5">Hello, this is some text</p>
</div>
```

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).

0 comments on commit cf566df

Please sign in to comment.