Skip to content

Commit d712e31

Browse files
committed
docs: readme updates RE v3.0.0
1 parent 3abe515 commit d712e31

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,18 @@
2121

2222
## Documentation
2323

24+
Version 3.0.0 is a major update for `react-fontawesome` with the library being rewritten from plain JS to TypeScript,
25+
amongst a number of performance improvements and optimisations to the `FontAwesomeIcon` React component.
26+
27+
While it is a major update, there should be no breaking changes aside from those noted in the Compatibility section below.
28+
29+
## Compatibility
30+
2431
With the release of FontAwesome v7, we have marked v5 as End-of-Life. Both v6 and v7 will continue to be supported.
2532

2633
In `react-fontawesome v3.0.0` we have also dropped support for End-of-Life versions of React and Node.js as well as IE11 browser support.
2734

28-
If you need to use `react-fontawesome`
29-
30-
## Compatibility
35+
If you need to use `react-fontawesome` with legacy versions, please consult the table below.
3136

3237
| React version | react-fontawesome version | FontAwesome Core versions | Node versions |
3338
| ------------- | ------------------------- | ------------------------- | ---------------- |

0 commit comments

Comments
 (0)