Skip to content

Commit 686e1ff

Browse files
committed
Adds BC break warning to README
1 parent 6637957 commit 686e1ff

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

+13
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,19 @@ domain parser implemented in PHP.
99
[![Total Downloads](https://poser.pugx.org/jeremykendall/php-domain-parser/downloads.png)](https://packagist.org/packages/jeremykendall/php-domain-parser)
1010
[![Latest Stable Version](https://poser.pugx.org/jeremykendall/php-domain-parser/v/stable.png)](https://packagist.org/packages/jeremykendall/php-domain-parser)
1111

12+
## WARNING: BC BREAK IN ALL 1.4 VERSIONS
13+
14+
The 1.4 series introduced a backwards incompatible change by adding PHP's `ext-mbstring`
15+
and `ext-intl` as dependencies. This should have resulted in a major version
16+
bump. Instead I bumped the minor version from 1.3.1 to 1.4.
17+
18+
I highly recommend reverting to 1.3.1 if you're running into extension issues and
19+
do not want to or cannot install `ext-mbstring` and `ext-intl`. You will lose
20+
IDNA and IPv6 support, however. Those are only available in versions >= 1.4.
21+
22+
Version 2 is currently in the works. Please keep an eye out. I apologize for any
23+
issues you may have encountered due my [semver](http://semver.org/) error.
24+
1225
Motivation
1326
----------
1427

0 commit comments

Comments
 (0)