-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |