diff --git a/README.md b/README.md index 1bd119d8..3356a40e 100644 --- a/README.md +++ b/README.md @@ -56,20 +56,6 @@ Pub: [FlutterQuill] - [License](#license) - [Contributors](#contributors) - - ## Installation ```yaml @@ -85,13 +71,10 @@ dependencies: git: https://github.com/singerdmx/flutter-quill.git ``` -> **Important note** -> -> Currently, we're in the process of refactoring the library's configurations. We're actively working on this, and while we don't have a development version available at the moment, your feedback is essential to us. > > Using the latest version and reporting any issues you encounter on GitHub will greatly contribute to the improvement of the library. Your input and insights are valuable in shaping a stable and reliable version for all our users. Thank you for being part of the open-source community! > -> also [flutter_quill_extensions](https://pub.dev/packages/flutter_quill_extensions) will not work with the latest versions, please use [fresh_quill_extensions](https://pub.dev/packages/fresh_quill_extensions) as temporary alternative +> Please use the latest pre-release of [FlutterQuill Extensions] in order to work with the latest stable version of [FlutterQuill] > ## Usage @@ -192,7 +175,7 @@ localizationsDelegates: const [ ], ``` -And you might need more depending on your use case, for example if you are using custom localizations for your app, using custom app widget like [FluentApp](https://pub.dev/packages/fluent_ui) +And you might need more depending on your use case, for example if you are using custom localizations for your app, using custom app widget like `FluentApp` from [FluentUI] which will also need ```dart @@ -205,6 +188,8 @@ localizationsDelegates: const [ in addition to the required delegates by this library +Note: In the latest versions of `FluentApp` you no longer need to add the `localizationsDelegates` but this is just an example, for more [info](https://github.com/bdlukaa/fluent_ui/pull/946) + ### Font Size Within the editor toolbar, a drop-down with font-sizing capabilities is available. This can be enabled or disabled with `showFontSize`. @@ -307,25 +292,6 @@ Expanded( ) ``` - - - ### Custom Size Image for Mobile Define `mobileWidth`, `mobileHeight`, `mobileMargin`, `mobileAlignment` as follows: @@ -737,11 +703,13 @@ Made with [contrib.rocks](https://contrib.rocks). [Quill]: https://quilljs.com/docs/formats [Flutter]: https://github.com/flutter/flutter [FlutterQuill]: https://pub.dev/packages/flutter_quill +[FlutterQuill Extensions]: https://pub.dev/packages/flutter_quill_extensions [ReactQuill]: https://github.com/zenoamaro/react-quill [Youtube Playlist]: https://youtube.com/playlist?list=PLbhaS_83B97vONkOAWGJrSXWX58et9zZ2 [Slack Group]: https://join.slack.com/t/bulletjournal1024/shared_invite/zt-fys7t9hi-ITVU5PGDen1rNRyCjdcQ2g [Sample Page]: https://github.com/singerdmx/flutter-quill/blob/master/example/lib/pages/home_page.dart [Code Introduction]: https://github.com/singerdmx/flutter-quill/blob/master/doc/CodeIntroduction.md +[FluentUI]: https://pub.dev/packages/fluent_ui