Skip to content

Commit 6c403fd

Browse files
committed
Update readme for v1.0
1 parent ea074a4 commit 6c403fd

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

readme.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,32 @@ npm install --save-dev tailwindcss-background-extended
1717
yarn add -D tailwindcss-background-extended
1818
```
1919

20-
## Notes
21-
22-
I will be adding support for creating classes for `background` and `background-image` soon-ish. Feel free to open an issue if you need it before I get to it.
23-
2420
## Usage
2521

2622
```js
27-
require('tailwindcss-background-extended')(['responsive'])
23+
// tailwind.config.js
24+
{
25+
theme: {
26+
backgroundImage: { // defaults to {}
27+
tailwindcss: "url('https://avatars0.githubusercontent.com/u/30317862')",
28+
},
29+
},
30+
31+
variants: { // all the following default to ['responsive']
32+
backgroundImage: ['responsive'],
33+
backgroundClip: ['responsive'],
34+
backgroundOrigin: ['responsive'],
35+
},
36+
37+
plugins: [
38+
require('tailwindcss-background-extended'), // no options to configure
39+
],
40+
}
2841
```
2942

3043
```css
44+
.bg-image-tailwindcss { background-image: url('https://avatars0.githubusercontent.com/u/30317862'); }
45+
3146
.bg-clip-border { background-clip: border-box; }
3247
.bg-clip-padding { background-clip: padding-box; }
3348
.bg-clip-content { background-clip: content-box; }

0 commit comments

Comments
 (0)