Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kaidesu committed Jul 1, 2018
1 parent ef9d309 commit 1708f6a
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,33 @@
# Yeoman Tailwind Generator
A simple Yeoman generator to scaffold Tailwind CSS, Vue, and Laravel Mix.

## Pre-requisites
Install [Yeoman](http://yeoman.io)

```bash
npm install -g yo
```

## Installation

```bash
npm install -g generator-caffeinated-tailwind
```

## Usage
To scaffold a new Caffeinated Tailwind project, run:

```bash
yo caffeinated-tailwind
```

## Development
To work on the generator locally, simply clone and link the package with npm:

```bash
git clone [email protected]:caffeinated/tailwind-generator.git
cd tailwind-generator
npm link
```

Now you may run `yo caffeinated-tailwind` per usual.

0 comments on commit 1708f6a

Please sign in to comment.