Skip to content

Commit 022bdf1

Browse files
authored
chore(docs): update installation and support tags
1 parent 58af161 commit 022bdf1

File tree

1 file changed

+44
-14
lines changed

1 file changed

+44
-14
lines changed

README.md

Lines changed: 44 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,14 @@ To install the plugin via npm, ensure that Tailwind CSS and its configuration ar
88

99
```bash
1010
npm install -D @halvaradop/tailwindcss-utilities
11+
npm install --save-dev @halvaradop/tailwindcss-utilities
1112
```
1213

1314
## Configuration
1415
To configure the plugin, add it to the plugins array in the Tailwind CSS configuration file.
1516

1617
```ts
17-
// ts
18+
// TypeScript
1819
import type { Config } from "tailwindcss";
1920
import plugin from "@halvaradop/tailwindcss-utilities"
2021

@@ -27,6 +28,19 @@ const config: Config = {
2728
export default config;
2829
```
2930

31+
```js
32+
// JavaScript
33+
import plugin from "@halvaradop/tailwindcss-utilities"
34+
35+
/** @type {import('tailwindcss').Config} */
36+
module.exports = {
37+
content: [],
38+
theme: {},
39+
plugins: [plugin],
40+
}
41+
42+
```
43+
3044
## Utilities
3145
Set of utilites offer by the dependency.
3246

@@ -36,32 +50,48 @@ The selectors utility offers a set of selectors that provide improved access to
3650

3751

3852
#### Supported Tags
39-
- `li`
53+
54+
55+
#### Structural Elements
56+
- `head`
57+
- `body`
58+
- `main`
59+
- `footer`
60+
- `section`
61+
- `article`
62+
- `label`
63+
- `nav`
4064
- `div`
41-
- `span`
42-
- `a`
65+
66+
#### Text Content
4367
- `p`
44-
- `img`
68+
- `span`
4569
- `h1` to `h6`
70+
- `a`
71+
72+
#### List
4673
- `ul`
4774
- `ol`
4875
- `li`
49-
- `table`
50-
- `tr`
51-
- `td`
76+
77+
#### Forms
78+
- `button`
5279
- `form`
5380
- `input`
54-
- `button`
55-
- `section`
56-
- `main`
57-
- `body`
58-
- `article`
5981
- `label`
82+
83+
#### Tables
84+
- `table`
85+
- `tr`
86+
- `td`
87+
88+
#### Media
6089
- `img`
6190
- `figure`
6291
- `picture`
6392
- `caption`
64-
- `footer`
93+
- `figcaption`
94+
6595

6696

6797
#### Usage

0 commit comments

Comments
 (0)