Skip to content

Commit eef18fa

Browse files
committed
docs: update md
1 parent 6cd9235 commit eef18fa

File tree

3 files changed

+18
-20
lines changed

3 files changed

+18
-20
lines changed

README.md

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -12,35 +12,18 @@ A util for mangle tailwindcss
1212

1313
- [tailwindcss-mangle](#tailwindcss-mangle)
1414
- [tailwindcss-patch](#tailwindcss-patch)
15-
- [@tailwindcss-mangle/core](#@tailwindcss-mangle/core)
16-
- [@tailwindcss-mangle/shared](#@tailwindcss-mangle/shared)
1715
- [unplugin-tailwindcss-mangle](#unplugin-tailwindcss-mangle)
18-
- [How to use](#how-to-use)
1916

2017
## tailwindcss-patch
2118

2219
`tailwindcss-patch` is a util to patch tailwindcss code and get it's context at runtime.
2320

2421
click [tailwindcss-patch](./packages/tailwindcss-patch) for more details.
2522

26-
## @tailwindcss-mangle/core
27-
28-
The core of tailwindcss-mangle
29-
30-
click [@tailwindcss-mangle/core](./packages/core) for more details.
31-
32-
## @tailwindcss-mangle/shared
33-
34-
The shared utils of tailwindcss-mangle
35-
36-
click [@tailwindcss-mangle/shared](./packages/shared) for more details.
37-
3823
## unplugin-tailwindcss-mangle
3924

25+
> It is recommended to read the documentation of [tailwindcss-patch](https://github.com/sonofmagic/tailwindcss-mangle/tree/main/packages/tailwindcss-patch) first, `unplugin-tailwindcss-mangle` depends on this tool.
26+
4027
`unplugin-tailwindcss-mangle` is a plugin for `webpack` and `vite` to **obfuscate** tailwindcss class.
4128

4229
you can enter [unplugin-tailwindcss-mangle](./packages/unplugin-tailwindcss-mangle) for usage and more details.
43-
44-
## How to use
45-
46-
See [unplugin-tailwindcss-mangle](./packages/unplugin-tailwindcss-mangle)

packages/unplugin-tailwindcss-mangle/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
mangle tailwindcss utilities plugin
44

5+
It is recommended to read the documentation of [tailwindcss-patch](https://github.com/sonofmagic/tailwindcss-mangle/tree/main/packages/tailwindcss-patch) first, `unplugin-tailwindcss-mangle` depends on this tool.
6+
57
> Now Support `vite` and `webpack`
68
79
- [unplugin-tailwindcss-mangle](#unplugin-tailwindcss-mangle)
@@ -16,6 +18,7 @@ mangle tailwindcss utilities plugin
1618
- [webpack](#webpack)
1719
- [Options](#options)
1820
- [Notice](#notice)
21+
- [Migration form v1 to v2](#migration-form-v1-to-v2)
1922

2023
## Features
2124

@@ -128,3 +131,15 @@ document.body.innerHTML = innerHTML
128131
```
129132

130133
so only strings with `-` or `:` will be transformed.
134+
135+
## Migration form v1 to v2
136+
137+
```diff
138+
// vite
139+
- import { vitePlugin } from 'unplugin-tailwindcss-mangle'
140+
+ import utwm from 'unplugin-tailwindcss-mangle/vite'
141+
142+
// webpack
143+
- import { webpackPlugin } from 'unplugin-tailwindcss-mangle'
144+
+ import utwm from 'unplugin-tailwindcss-mangle/webpack'
145+
```

packages/unplugin-tailwindcss-mangle/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "unplugin-tailwindcss-mangle",
3-
"version": "2.0.1",
3+
"version": "2.0.2",
44
"description": "mangle tailwindcss utilities class plugin. support vite and webpack!",
55
"main": "./dist/index.cjs",
66
"module": "./dist/index.mjs",

0 commit comments

Comments
 (0)