docs: update md

sonofmagic · Aug 9, 2023 · eef18fa · eef18fa
1 parent 6cd9235
commit eef18fa
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -12,35 +12,18 @@ A util for mangle tailwindcss
 
 - [tailwindcss-mangle](#tailwindcss-mangle)
   - [tailwindcss-patch](#tailwindcss-patch)
-  - [@tailwindcss-mangle/core](#@tailwindcss-mangle/core)
-  - [@tailwindcss-mangle/shared](#@tailwindcss-mangle/shared)
   - [unplugin-tailwindcss-mangle](#unplugin-tailwindcss-mangle)
-  - [How to use](#how-to-use)
 
 ## tailwindcss-patch
 
 `tailwindcss-patch` is a util to patch tailwindcss code and get it's context at runtime.
 
 click [tailwindcss-patch](./packages/tailwindcss-patch) for more details.
 
-## @tailwindcss-mangle/core
-
-The core of tailwindcss-mangle
-
-click [@tailwindcss-mangle/core](./packages/core) for more details.
-
-## @tailwindcss-mangle/shared
-
-The shared utils of tailwindcss-mangle
-
-click [@tailwindcss-mangle/shared](./packages/shared) for more details.
-
 ## unplugin-tailwindcss-mangle
 
+> 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.
+
 `unplugin-tailwindcss-mangle` is a plugin for `webpack` and `vite` to **obfuscate** tailwindcss class.
 
 you can enter [unplugin-tailwindcss-mangle](./packages/unplugin-tailwindcss-mangle) for usage and more details.
-
-## How to use
-
-See [unplugin-tailwindcss-mangle](./packages/unplugin-tailwindcss-mangle)
diff --git a/packages/unplugin-tailwindcss-mangle/README.md b/packages/unplugin-tailwindcss-mangle/README.md
@@ -2,6 +2,8 @@
 
 mangle tailwindcss utilities plugin
 
+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.
+
 > Now Support `vite` and `webpack`
 
 - [unplugin-tailwindcss-mangle](#unplugin-tailwindcss-mangle)
@@ -16,6 +18,7 @@ mangle tailwindcss utilities plugin
       - [webpack](#webpack)
   - [Options](#options)
   - [Notice](#notice)
+  - [Migration form v1 to v2](#migration-form-v1-to-v2)
 
 ## Features
 
@@ -128,3 +131,15 @@ document.body.innerHTML = innerHTML
 ```
 
 so only strings with `-` or `:` will be transformed.
+
+## Migration form v1 to v2
+
+```diff
+// vite
+- import { vitePlugin } from 'unplugin-tailwindcss-mangle'
++ import utwm from 'unplugin-tailwindcss-mangle/vite'
+
+// webpack
+- import { webpackPlugin } from 'unplugin-tailwindcss-mangle'
++ import utwm from 'unplugin-tailwindcss-mangle/webpack'
+```
diff --git a/packages/unplugin-tailwindcss-mangle/package.json b/packages/unplugin-tailwindcss-mangle/package.json
@@ -1,6 +1,6 @@
 {
   "name": "unplugin-tailwindcss-mangle",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "mangle tailwindcss utilities class plugin. support vite and webpack!",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",