Skip to content

Commit 5f4f56b

Browse files
chore: small migration guide
1 parent 4d37843 commit 5f4f56b

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,22 @@ export default {
181181
}
182182
```
183183

184+
## Migrating from v0.x
185+
186+
1. Review the [**Release Notes**](./CHANGELOG.md) for all changes
187+
2. Bump to 1.x
188+
3. Ensure the plugin is running in the right mode
189+
* If you used the default mode, you have to add `mode: 'webpack'` to your config.
190+
* If you used the `postcss` mode, you can remove the `mode: 'postcss'` line from your config
191+
* If you used this module only with the [Nuxt `tailwind` module](https://github.com/nuxt-community/tailwindcss-module), you don't need to do anything
192+
4. Read about the internal changes of [PurgeCSS 2](https://github.com/fullhuman/purgecss/releases)
193+
5. Update your extractor and change the syntax from a class to a function (see 4.)
194+
6. Unused styles from SFCs are now purged. If you don't want that, whitelist them.
195+
7. The regex for CSS classes changed. This should not be breaking in most cases.
196+
8. The whitelist now includes nuxt link classes (e.g. `nuxt-link-active`). If you whitelisted these before, you can remove them.
197+
9. The whitelist now includes move transition classes. If you whitelisted these before, you can remove them.
198+
10. Test on your staging server (or locally) before deploying!
199+
184200
## License
185201

186202
[MIT License](./LICENSE)

0 commit comments

Comments
 (0)