diff --git a/README.md b/README.md index afe1db5eb6..aa40f8117f 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,9 @@

Super Editor was initiated by Superlist and is implemented and maintained by the Flutter Bounty Hunters, Superlist, and the contributors.

-

Feel free to join us on Slack and say hello 👋.

+
+ +

Do you use Flutter's stable branch? Be sure to checkout super_editor's stable branch, for compatibility.
Do you use Flutter's master branch? Be sure to checkout super_editor's main branch, for compabitility.


@@ -15,9 +17,9 @@

Super Editor & Super Text Field

-Please see the [SuperEditor README](super_editor/README.md) about how to use the packages, or run the [sample editor](super_editor/example/README.md). +Please see the [SuperEditor README](super_editor/README.md) about how to use the packages, or run the [sample editor](super_editor/example/README.md). -A web demo is accessible at [https://superlist.com/SuperEditor](https://superlist.com/SuperEditor/). +A web demo is accessible at [https://superlist.com/SuperEditor](https://superlist.com/SuperEditor/).
@@ -30,3 +32,31 @@ You might notice that this is a mono-repo, which includes multiple projects. Tha Attributed Text

+

Mono-repo Versioning

+If you have compilation errors when using the GitHub version of super_editor, try overriding dependencies for the other packages in this mono-repo, e.g., super_editor_markdown, super_text_layout, and attributed_text. This project often makes changes to multiple packages within the mono-repo, which requires that you use the latest main or stable version of every package. + +You can override your dependencies as follows: + +```yaml +dependency_overrides: + super_editor: + git: + url: https://github.com/superlistapp/super_editor + path: super_editor + ref: stable # or "main" + super_editor_markdown: + git: + url: https://github.com/superlistapp/super_editor + path: super_editor_markdown + ref: stable + super_text_layout: + git: + url: https://github.com/superlistapp/super_editor + path: super_text_layout + ref: stable + attributed_text: + git: + url: https://github.com/superlistapp/super_editor + path: attributed_text + ref: stable +```