Skip to content

Commit c4ed71b

Browse files
committed
Update README
1 parent 5eb4824 commit c4ed71b

File tree

1 file changed

+33
-29
lines changed

1 file changed

+33
-29
lines changed

README.md

Lines changed: 33 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,33 @@
1-
# tailwind-config-viewer
2-
3-
## Project setup
4-
```
5-
npm install
6-
```
7-
8-
### Compiles and hot-reloads for development
9-
```
10-
npm run serve
11-
```
12-
13-
### Compiles and minifies for production
14-
```
15-
npm run build
16-
```
17-
18-
### Run your tests
19-
```
20-
npm run test
21-
```
22-
23-
### Lints and fixes files
24-
```
25-
npm run lint
26-
```
27-
28-
### Customize configuration
29-
See [Configuration Reference](https://cli.vuejs.org/config/).
1+
# Tailwind Config Viewer
2+
3+
![Screenshot of UI](https://github.com/rogden/tailwind-config-viewer/raw/master/ui-example.jpg)
4+
5+
Tailwind Config Viewer is a local UI tool for visualizing your Tailwind CSS configuration file. Keep it open during development to quickly reference custom Tailwind values/classes. Easily navigate between sections of the configuration and copy class names to your clipboard by clicking on them.
6+
7+
## Installation
8+
9+
### NPX
10+
Run `npx tailwind-config-viewer` from within the directory that contains your Tailwind configuration file.
11+
12+
### Globally
13+
`npm i tailwind-config-viewer`
14+
15+
### Locally
16+
`npm i tailwind-config-viewer -D`
17+
18+
## Usage
19+
Run the `tailwind-config-viewer` command from within the directory that contains your Tailwind configuration file.
20+
21+
## Options
22+
There are a few options you can provide to the `tailwind-config-viewer` command.
23+
24+
|Option|Default|Description|
25+
|----|----|----|
26+
|-p, --port|`3000`|The port to run the viewer on. If occupied it will use next available port.|
27+
|-o, --open|`false`|Open the viewer in default browser|
28+
|-c, --config|`tailwind.config.js`|Path to your Tailwind config file|
29+
30+
## Roadmap
31+
- [ ] Add support for loading custom fonts / font family section
32+
- [ ] Add Transition section
33+
- [ ] Dark Mode toggle

0 commit comments

Comments
 (0)