Skip to content

Commit

Permalink
docs: update disclaimer about compatible Tailwind versions
Browse files Browse the repository at this point in the history
  • Loading branch information
thibaudcolas committed Oct 25, 2022
1 parent b60d77a commit 589fbc7
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Simple right-to-left (RTL) language support for Tailwind, switching vanilla util

This plugin overrides Tailwind’s core’s utility classes, making it very straightforward to add RTL support. Have a look at the [browser support](#browser-support), [design decisions](#design-decisions), and [alternatives](#alternatives) to confirm which is the right fit for your project.

The plugin is compatible with Tailwind v3.1 and up. Install the package, add it to the `plugins`, and disable the `corePlugins` it overrides.
Install the package, add it to the `plugins`, and disable the `corePlugins` it overrides.

```bash
npm install tailwindcss-vanilla-rtl --save-dev
Expand All @@ -30,6 +30,8 @@ module.exports = {

That’s it. Since the plugin uses the same utility classes as Tailwind core (`ml-4`, `px-10`, etc.), there are no new utilities to learn, no code to change.

The plugin is compatible with Tailwind v3.2 and up. For compatibility with older releases of Tailwind (starting with v3.0), use older releases of the package. See our [CHANGELOG](https://github.com/thibaudcolas/tailwindcss-vanilla-rtl/blob/main/CHANGELOG.md) to learn which release is compatible with each version of Tailwind.

## Browser support

Browser support for CSS logical properties and values is still very recent. This plugin has full support for Safari 15, Chrome/Edge 89, and Firefox 68.
Expand Down

0 comments on commit 589fbc7

Please sign in to comment.