Skip to content

Commit b54be78

Browse files
committed
Updates readme with config options
1 parent 53fd9ce commit b54be78

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed

README.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,38 @@ module.exports = {
2727
// ...
2828
},
2929
plugins: [
30-
require('tailwindcss-question-mark'),
30+
require("tailwindcss-question-mark"),
3131
// ...
3232
],
33-
}
33+
};
3434
```
3535

3636
## Usage
3737

3838
Simply add the `?` utility class to any element that you'd like to highlight.
3939

40-
**Demo**: https://play.tailwindcss.com/fXhD65EpG4?layout=horizontal
40+
**Demo**: https://play.tailwindcss.com/fXhD65EpG4?layout=horizontal
41+
42+
## Customizing
43+
44+
Below is an example of how you can customize the plugin with the available configuration options and their defaults.
45+
46+
```js
47+
// tailwind.config.js
48+
module.exports = {
49+
theme: {
50+
// ...
51+
},
52+
plugins: [
53+
require("tailwindcss-question-mark")({
54+
animationDuration: "0.6s",
55+
enableAnimation: true,
56+
highlightColorStart: "#f16bc9",
57+
highlightColorEnd: "#f71fb6",
58+
widthStart: "8px",
59+
widthEnd: "12px",
60+
}),
61+
// ...
62+
],
63+
};
64+
```

0 commit comments

Comments
 (0)