Skip to content

Commit 1db8571

Browse files
committed
doc: add an upgrade note to the README
1 parent 5472dad commit 1db8571

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

+14
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,20 @@ A self-contained `tailwindcss` executable, wrapped up in a ruby gem. That's it.
55
If you're looking to leverage tailwindcss in your Rails project, please see https://github.com/rails/tailwindcss-rails for integration that is supported by the Rails team.
66

77

8+
## ⚠ Upgrade note ⚠
9+
10+
To upgrade an existing application from v3 to v4, I strongly urge you to read the upstream upgrade guide: https://tailwindcss.com/docs/upgrade-guide.
11+
12+
For Rails users, if you want to upgrade you may want to check out [TailwindCSS v4 - upgrade experience report · rails/tailwindcss-rails · Discussion #450](https://github.com/rails/tailwindcss-rails/discussions/450).
13+
14+
In any case, if you're not ready to upgrade to v4, then pin your project to the 3.x releases:
15+
16+
```ruby
17+
# If you're not ready to upgrade yet!
18+
gem "tailwindcss-ruby", "~> 3.4"
19+
```
20+
21+
822
## Installation
923

1024
This gem wraps [the standalone executable version](https://tailwindcss.com/blog/standalone-cli) of the Tailwind CSS v4 framework. These executables are platform specific, so there are actually separate underlying gems per platform, but the correct gem will automatically be picked for your platform.

0 commit comments

Comments
 (0)