Skip to content

Commit bcb9403

Browse files
committed
Updated readme
1 parent d97ae65 commit bcb9403

File tree

1 file changed

+26
-5
lines changed

1 file changed

+26
-5
lines changed

README.md

+26-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Scale Utilities Plugin for Tailwind CSS
22

3-
![](https://image.ibb.co/hgnwNx/logo.jpg)
4-
53
[![npm](https://img.shields.io/npm/v/@kirschbaum-development/tailwindcss-scale-utilities.svg)](https://www.npmjs.com/package/@kirschbaum-development/tailwindcss-scale-utilities)
64
[![npm](https://img.shields.io/npm/dt/@kirschbaum-development/tailwindcss-scale-utilities.svg)](https://www.npmjs.com/package/@kirschbaum-development/tailwindcss-scale-utilities)
75
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://www.npmjs.com/package/@kirschbaum-development/tailwindcss-scale-utilities)
@@ -19,24 +17,42 @@ or
1917
$ npm install @kirschbaum-development/tailwindcss-scale-utilities --save-dev
2018
```
2119

20+
## Defaults
21+
22+
```js
23+
theme: {
24+
scale: {
25+
0: 0,
26+
25: '.25',
27+
50: '.5',
28+
75: '.75',
29+
1: 1
30+
}
31+
},
32+
33+
variants: {
34+
scale: ['responsive', 'hover', 'focus']
35+
}
36+
```
37+
2238
## Usage
2339

2440
```js
2541
// tailwind.config.js
2642
{
2743
theme: {
28-
scale: { // defaults to { 0: 0, 25: '.25', 50: '.5', 75: '.75', 100: 1 }
44+
scale: {
2945
'90': '0.9',
3046
'100': '1',
3147
'110': '1.1'
3248
}
3349
},
34-
variants: { // defaults to ['responsive', 'hover', 'focus']
50+
variants: {
3551
scale: ['responsive']
3652
},
3753
plugins: [
3854
require('tailwindcss-scale-utilities')()
39-
],
55+
]
4056
}
4157
```
4258

@@ -47,4 +63,9 @@ This plugin generates the following utilities:
4763
.scale-[key] {
4864
transform: scale([value]);
4965
}
66+
67+
/* specifying a negative key will follow framework conventions */
68+
.-scale-[key] {
69+
transform: scale([value]);
70+
}
5071
```

0 commit comments

Comments
 (0)