Skip to content

Commit

Permalink
doc: add limitations section
Browse files Browse the repository at this point in the history
  • Loading branch information
sastan committed Mar 25, 2021
1 parent 91b826f commit bdf52a5
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,16 @@ twind -c tailwind.prod.js
-h, --help Displays this message
```

## Limitations

@twind/cli is a utility that can greatly help in some cases, however in practice it can also:

- the grouping feature is currently **not** supported
- yield "false positives" (i.e. detect TailwindCSS classes / selectors that are not actually used, due to broad string-based / regular expression search)
- give false impressions (e.g. class names generated by Twind at runtime via `css()`, `apply()` and `style()` cannot possibly be computed via static code analysis, so the CLI-generated stylesheet is likely incomplete in most realistic use-cases).

Please see [issue #1](https://github.com/tw-in-js/twind-cli/issues/1) for more details.

## License

[MIT](https://github.com/tw-in-js/cli/blob/main/LICENSE)

0 comments on commit bdf52a5

Please sign in to comment.