Skip to content

Commit 64b6fa9

Browse files
authored
docs(readme): add 'Breaking Changes' section (singerdmx#2275)
1 parent 7f96ea7 commit 64b6fa9

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ You can join our [Slack Group] for discussion.
5353
- [📦 Installation](#-installation)
5454
- [🛠 Platform Specific Configurations](#-platform-specific-configurations)
5555
- [🚀 Usage](#-usage)
56+
- [💥 Breaking Changes](#-breaking-changes)
5657
- [🔤 Input / Output](#-input--output)
5758
- [⚙️ Configurations](#️-configurations)
5859
- [📦 Embed Blocks](#-embed-blocks)
@@ -158,6 +159,23 @@ void dispose() {
158159

159160
Check out [Sample Page] for more advanced usage.
160161

162+
## 💥 Breaking Changes
163+
164+
- APIs marked with [`@experimental`](https://api.flutter.dev/flutter/meta/experimental-constant.html)
165+
are subject to change or removal at any time and should be used with caution,
166+
as they may be altered even in minor versions.
167+
168+
- APIs marked with [`@internal`](https://api.flutter.dev/flutter/meta/internal-constant.html)
169+
and [`@visibleForTesting`](https://api.flutter.dev/flutter/meta/visibleForTesting-constant.html) are not intended for
170+
public use and should be avoided entirely.
171+
172+
- The `package:flutter_quill/flutter_quill_internal.dart` expose internal APIs
173+
to be used by other related packages and should be avoided when possible.
174+
175+
We make every effort to ensure internal APIs are not exported by default. Use experimental features at your own discretion.
176+
177+
We recommend checking the `CHANGELOG.md` or release notes for each update to stay informed.
178+
161179
## 🔤 Input / Output
162180

163181
This library uses [Quill Delta](https://quilljs.com/docs/delta/)

0 commit comments

Comments
 (0)