Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): update installation and support tags #43

Merged
merged 1 commit into from
Jul 27, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 44 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,14 @@ To install the plugin via npm, ensure that Tailwind CSS and its configuration ar

```bash
npm install -D @halvaradop/tailwindcss-utilities
npm install --save-dev @halvaradop/tailwindcss-utilities
```

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

```ts
// ts
// TypeScript
import type { Config } from "tailwindcss";
import plugin from "@halvaradop/tailwindcss-utilities"

Expand All @@ -27,6 +28,19 @@ const config: Config = {
export default config;
```

```js
// JavaScript
import plugin from "@halvaradop/tailwindcss-utilities"

/** @type {import('tailwindcss').Config} */
module.exports = {
content: [],
theme: {},
plugins: [plugin],
}

```

## Utilities
Set of utilites offer by the dependency.

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


#### Supported Tags
- `li`


#### Structural Elements
- `head`
- `body`
- `main`
- `footer`
- `section`
- `article`
- `label`
- `nav`
- `div`
- `span`
- `a`

#### Text Content
- `p`
- `img`
- `span`
- `h1` to `h6`
- `a`

#### List
- `ul`
- `ol`
- `li`
- `table`
- `tr`
- `td`

#### Forms
- `button`
- `form`
- `input`
- `button`
- `section`
- `main`
- `body`
- `article`
- `label`

#### Tables
- `table`
- `tr`
- `td`

#### Media
- `img`
- `figure`
- `picture`
- `caption`
- `footer`
- `figcaption`



#### Usage
Expand Down