Skip to content

Commit aeb355c

Browse files
committed
Added more documentation for Tailwind CSS 4 support.
1 parent a839d2f commit aeb355c

File tree

3 files changed

+18
-4
lines changed

3 files changed

+18
-4
lines changed

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
- The management subcommand `runserver` has a option `--force-default-runserver` to enforce the
1515
usage of the standard debug server from Django.
1616
- `TAILWIND_CLI_CONFIG_FILE` isn't necessary for Tailwind CSS 4.x only for 3.x.
17-
[Read the documentaiton about it.](settings.md)
17+
[Read the documentaiton about it.](https://django-tailwind-cli.rtfd.io/latest/installation/settings)
1818
- Removed the documentation for the fancier `tailwind.config.js` as it is not recommended to use
1919
and Tailwind CSS 4.x has a way better strategy to find the used Tailwind classes.
2020

README.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,14 @@ The goal of this library is to provided the simplest possible Tailwind integrati
5757

5858
Enjoy!
5959

60-
Checkout the detailed [installation guide](https://django-tailwind-cli.rtfd.io/latest/installation/) if you want to activate browser reload or the `runserver_plus` management command known from `django-extensions`.
60+
Checkout the detailed [installation guide](https://django-tailwind-cli.rtfd.io/latest/installation/)
61+
if you want to activate browser reload or the `runserver_plus` management command known from
62+
`django-extensions`.
6163

6264
## Features
6365

6466
- Simplest possible integration.
65-
- Support Tailwind CSS 3.x and 4.x.
67+
- Support Tailwind CSS 3.x and 4.x. Check the [update instructions](https://django-tailwind-cli.rtfd.io/latest/installation/#upgrade-from-tailwind-css-3x-to-4x).
6668
- Management commands:
6769

6870
* To start the Tailwind CLI in watch mode during development.
@@ -85,7 +87,10 @@ The documentation can be found at [https://django-tailwind-cli.rtfd.io/](https:/
8587

8688
## Contributing
8789

88-
This package requires [uv](https://docs.astral.sh/uv/) for dependency management and tooling. So you have to [install it](https://docs.astral.sh/uv/getting-started/installation/) first. [just](https://github.com/casey/just) is used as a handy command runner to save some typing on the command line. Do yourself a favor and install it too.
90+
This package requires [uv](https://docs.astral.sh/uv/) for dependency management and tooling. So you
91+
have to [install it](https://docs.astral.sh/uv/getting-started/installation/) first.
92+
[just](https://github.com/casey/just) is used as a handy command runner to save some typing on the
93+
command line. Do yourself a favor and install it too.
8994

9095
```shell
9196
# Setup development environment

docs/installation.md

+9
Original file line numberDiff line numberDiff line change
@@ -120,3 +120,12 @@ If you enjoy automatic reloading during development. Install the [django-browser
120120
The middleware should be listed after any that encodes the response, such as Django’s GZipMiddleware.
121121

122122
The middleware automatically inserts the required script tag on HTML responses before </body> when DEBUG is True. It does so to every HTML response, meaning it will be included on Django’s debug pages, admin pages, etc. If you want more control, you can instead insert the script tag in your templates—see below.
123+
124+
## Upgrade from Tailwind CSS 3.x to 4.x
125+
126+
In order to upgrade this package from using Tailwind CSS 3.x to 4.x, you have to follow some simple
127+
steps.
128+
129+
- Remove or change the setting `TAILWIND_CLI_VERSION` if it is set.
130+
- Remove the setting `TAILWIND_CLI_CONFIG_FILE` if it is set.
131+
- Remove the `tailwind.config.js` your project.

0 commit comments

Comments
 (0)