Skip to content

Commit 1a97355

Browse files
committed
update webpack readme to be a bit more consistent with other readmes
1 parent 14083ad commit 1a97355

1 file changed

Lines changed: 44 additions & 5 deletions

File tree

packages/@tailwindcss-webpack/README.md

Lines changed: 44 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,43 @@
1-
# @tailwindcss/webpack
1+
<p align="center">
2+
<a href="https://tailwindcss.com" target="_blank">
3+
<picture>
4+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/tailwindlabs/tailwindcss/HEAD/.github/logo-dark.svg">
5+
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/tailwindlabs/tailwindcss/HEAD/.github/logo-light.svg">
6+
<img alt="Tailwind CSS" src="https://raw.githubusercontent.com/tailwindlabs/tailwindcss/HEAD/.github/logo-light.svg" width="350" height="70" style="max-width: 100%;">
7+
</picture>
8+
</a>
9+
</p>
10+
11+
<p align="center">
12+
A utility-first CSS framework for rapidly building custom user interfaces.
13+
</p>
14+
15+
<p align="center">
16+
<a href="https://github.com/tailwindlabs/tailwindcss/actions"><img src="https://img.shields.io/github/actions/workflow/status/tailwindlabs/tailwindcss/ci.yml?branch=main" alt="Build Status"></a>
17+
<a href="https://www.npmjs.com/package/tailwindcss"><img src="https://img.shields.io/npm/dt/tailwindcss.svg" alt="Total Downloads"></a>
18+
<a href="https://github.com/tailwindlabs/tailwindcss/releases"><img src="https://img.shields.io/npm/v/tailwindcss.svg" alt="Latest Release"></a>
19+
<a href="https://github.com/tailwindlabs/tailwindcss/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/tailwindcss.svg" alt="License"></a>
20+
</p>
21+
22+
---
23+
24+
## Documentation
25+
26+
For full documentation, visit [tailwindcss.com](https://tailwindcss.com).
27+
28+
## Community
29+
30+
For help, discussion about best practices, or feature ideas:
31+
32+
[Discuss Tailwind CSS on GitHub](https://github.com/tailwindlabs/tailwindcss/discussions)
33+
34+
## Contributing
35+
36+
If you're interested in contributing to Tailwind CSS, please read our [contributing docs](https://github.com/tailwindlabs/tailwindcss/blob/main/.github/CONTRIBUTING.md) **before submitting a pull request**.
37+
38+
---
39+
40+
## @tailwindcss/webpack
241

342
A webpack loader for Tailwind CSS v4.
443

@@ -8,7 +47,7 @@ A webpack loader for Tailwind CSS v4.
847
npm install @tailwindcss/webpack
948
```
1049

11-
## Usage
50+
### Usage
1251

1352
```javascript
1453
// webpack.config.js
@@ -34,9 +73,9 @@ Then create a CSS file that imports Tailwind:
3473
@import 'tailwindcss';
3574
```
3675

37-
## Options
76+
### Options
3877

39-
### `base`
78+
#### `base`
4079

4180
The base directory to scan for class candidates. Defaults to the current working directory.
4281

@@ -49,7 +88,7 @@ The base directory to scan for class candidates. Defaults to the current working
4988
}
5089
```
5190

52-
### `optimize`
91+
#### `optimize`
5392

5493
Whether to optimize and minify the output CSS. Defaults to `true` in production mode.
5594

0 commit comments

Comments
 (0)