Skip to content
This repository has been archived by the owner on Jun 13, 2024. It is now read-only.

Commit

Permalink
Add import for quick start and move examples around
Browse files Browse the repository at this point in the history
  • Loading branch information
GriffinSauce committed Jul 25, 2021
1 parent fff17ab commit 78d8431
Showing 1 changed file with 19 additions and 13 deletions.
32 changes: 19 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,24 @@
# Tailshake

Tailshake combines TailwindCSS classes and shakes off any conflicts.
Tailshake combines TailwindCSS classes and shakes off any conflicts. It helps compose and toggle Tailwind styles.

## Install

```
yarn add tailshake
// or
npm install tailshake
```

## Usage examples

```.tsx
import tailshake from 'tailshake'
```

A simple example:

```.js
tailshake("text-white", "text-gray-100") // => "text-gray-100"
Expand All @@ -15,18 +33,6 @@ isDisabled = false // => "text-blue-400"
isDisabled = true // => "text-gray-400"
```

## Install

```
yarn add tailshake
// or
npm install tailshake
```

## Usage examples

_Examples use React but the library does not care where you use it. :)_

### Compose classlists for legibility
Expand Down

0 comments on commit 78d8431

Please sign in to comment.