upgrade doc

CHANGELOG.md

@@ -6,6 +6,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## 3.4.0 ()
 
+> Please be aware that this release may impact the way Quill data is displayed in your frontend. Checkout the [upgrade document](UPGRADE.md) for more details.
+
 + [#80](https://github.com/nadar/quill-delta-parser/issues/80) Add missing background color listener.
 
 ## 3.3.1 (24. March 2023)

README.md

@@ -115,7 +115,7 @@ Certain listeners (image, video, color) produce a HTML output which maybe not su
 $image = new Image();
 $image->wrapper = '<img src="{src}" class="my-image" />';
 
-// override the default plugin from the lexer:
+// override the default listener behavior for image color:
 $lexer = new Lexer($json);
 $lexer->registerListener($image);
 echo $lexer->render();

UPGRADE.md

@@ -2,6 +2,20 @@
 
 This document will help you upgrading from a version into another. For more detailed informations about the breaking changes **click the issue detail link**, there you can see examples of how to change your code.
 
+## from 3.3.x to 3.4
+
++ [#80](https://github.com/nadar/quill-delta-parser/issues/80) When your Quill code contains background color information within the Quill data, and it is unexpectedly affecting the text color, you can disable this feature by following these steps:
+
+```php
+$backgroundColor = new BackgroundColor();
+$backgroundColor->ignore = true;
+
+// override the default listener behavior for background color:
+$lexer = new Lexer($json);
+$lexer->registerListener($backgroundColor);
+echo $lexer->render();
+```
+
 ## from 2.x to 3.0
 
 + [#61](https://github.com/nadar/quill-delta-parser/pull/61) PHP 7.1 is official dropped in unit tests. The code should still work with PHP 7.1 until next major release.