chore: add migration guide

AppFlowy-IO · Jul 12, 2023 · 16c488f · 16c488f
1 parent 9ad7b31
commit 16c488f
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -115,6 +115,9 @@ Below are some examples of shortcut event customizations:
  * [BIUS](https://github.com/AppFlowy-IO/appflowy-editor/tree/main/lib/src/editor/editor_component/service/shortcuts/character_shortcut_events/format_single_character) demonstrates how to make text bold/italic/underline/strikethrough through shortcut keys
  * Need more examples? Check out [shortcuts](https://github.com/AppFlowy-IO/appflowy-editor/tree/main/lib/src/editor/editor_component/service/shortcuts)
 
+## Migration Guide
+Please refer to the [migration documentation]((https://github.com/AppFlowy-IO/appflowy-editor/blob/main/documentation/migration.md)).
+
 ## Glossary
 Please refer to the API documentation.
 

diff --git a/documentation/migration.md b/documentation/migration.md
@@ -0,0 +1,9 @@
+# Migration Guide
+
+## From 1.1.0 to 1.2.0
+
+- `AppFlowyEditor.custom` and `AppFlowyEditor.standard` have been removed. Use `AppFlowyEditor.` instead.
+  - For now, we provide the default values to the `blockComponentBuilders`, `characterShortcutEvents`, and `commandShortcutEvents` if you do not customize them.
+- `DefaultSelectable` has been renamed to `DefaultSelectableMixin`
+- `FlowyRichText` has been renamed to `AppFlowyRichText`.
+- Added new parameter called `context`(BuildContext) into `TextSpanDecoratorForAttribute`.