Skip to content

Commit 150a99f

Browse files
authored
Update README.md
1 parent e4c5022 commit 150a99f

File tree

1 file changed

+14
-15
lines changed

1 file changed

+14
-15
lines changed

README.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -44,18 +44,18 @@ Make sure the class is only present during development. Here's an example of how
4444

4545
### Customization
4646

47-
You can customize the position and styles in the `theme.debugScreens` section of your `tailwind.config.js` file.
47+
You can customize this plugin in the `theme.debugScreens` section of your `tailwind.config.js` file.
4848

49-
#### Position
49+
#### Ignore screens
5050

51-
The first item of the position configuration array can be `top` or `bottom`, the second item can be `left` or `right`.
51+
To ignore a specific screen (for instance if you use [dark mode](https://tailwindcss.com/docs/breakpoints/#dark-mode)), add the screen name to the `ignore` configuration array.
5252

5353
```js
5454
// tailwind.config.js
5555
module.exports = {
5656
theme: {
5757
debugScreens: {
58-
position: ['bottom', 'left'],
58+
ignore: ['dark'],
5959
},
6060
},
6161
plugins: [
@@ -64,20 +64,16 @@ module.exports = {
6464
}
6565
```
6666

67-
#### Styles
67+
#### Position
6868

69-
Take a look at the [index.js](index.js) file to see all the default styles.
69+
The first item of the position configuration array can be `top` or `bottom`, the second item can be `left` or `right`.
7070

7171
```js
7272
// tailwind.config.js
7373
module.exports = {
7474
theme: {
7575
debugScreens: {
76-
style: {
77-
backgroundColor: '#C0FFEE',
78-
color: 'black',
79-
// ...
80-
},
76+
position: ['bottom', 'left'],
8177
},
8278
},
8379
plugins: [
@@ -86,17 +82,20 @@ module.exports = {
8682
}
8783
```
8884

89-
#### Ignoring Screens
85+
#### Styles
9086

91-
In some cases, like a custom screen media query, it can be helpful to ignore a specific screen. In that case
92-
add the screen name to the `ignore` configuration array.
87+
Take a look at the [index.js](index.js) file to see all the default styles.
9388

9489
```js
9590
// tailwind.config.js
9691
module.exports = {
9792
theme: {
9893
debugScreens: {
99-
ignore: ["custom-screen-name"],
94+
style: {
95+
backgroundColor: '#C0FFEE',
96+
color: 'black',
97+
// ...
98+
},
10099
},
101100
},
102101
plugins: [

0 commit comments

Comments
 (0)