diff --git a/flutter_quill_extensions/README.md b/flutter_quill_extensions/README.md index ddf9fdc5..e209c4ab 100644 --- a/flutter_quill_extensions/README.md +++ b/flutter_quill_extensions/README.md @@ -59,7 +59,7 @@ dependencies: The package uses the following plugins: -1. [`gal`](https://github.com/natsuk4ze/) plugin to save images. +1. [`gal`](https://github.com/natsuk4ze/gal) plugin to save images. For this to work, you need to add the appropriate configurations See to add the needed lines. 2. [`image_picker`](https://pub.dev/packages/image_picker) plugin for picking images so please make sure to follow the @@ -74,7 +74,7 @@ The package uses the following plugins: handle that if you plan on adding support for the desktop, this may change in the future, and for more info follow this [link](https://pub.dev/packages/image_picker#windows-macos-and-linux) 5. [`super_clipboard`](https://pub.dev/packages/super_clipboard) which needs some setup on Android only, it's used to - support copying images and pasting them into editor, open the page in pub.dev and read + support copying images and pasting them into editor, it's also required to support rich text pasting feature on non-web platforms, open the page in pub.dev and read the `README.md` or click on this [link](https://pub.dev/packages/super_clipboard#android-support) to get the instructions. @@ -85,10 +85,10 @@ The minSdkVersion is `23` as `super_clipboard` requires it > **Android**: you need to add permissions in `AndroidManifest.xml`, Follow > this [Android Guide](https://developer.android.com/training/basics/network-ops/connecting) > or [Flutter Networking](https://docs.flutter.dev/data-and-backend/networking#android) for more info, the internet -> permission is included by default only for debugging, you need to follow this link to add it in the release version -> too. you should allow loading images and videos only for the `https` protocol but if you want http too then you need +> permission is included by default only for debugging, you need to follow this link to add it to the release version +> too. you should allow loading images and videos only for the `https` protocol but if you want HTTP too then you need > to -> configure your Android application to accept `http` in the release mode, follow +> Configure your Android application to accept `http` in the release mode, follow > this [Android Cleartext / Plaintext HTTP](https://developer.android.com/privacy-and-security/risks/cleartext) page for > more info.

> **macOS**: you need to include a key in your `Info.plist`, follow @@ -97,8 +97,6 @@ The minSdkVersion is `23` as `super_clipboard` requires it ## 🚀 Usage -Start using the package in 3 steps: - Be sure to follow the [Installation](#installation) section. Set the `embedBuilders` and `embedToolbar` params in configurations of `QuillEditor` and `QuillToolbar`. @@ -128,12 +126,12 @@ Expanded( ### 📦 Embed Blocks As of version [flutter_quill](https://pub.dev/packages/flutter_quill) `6.0.x`, embed blocks are not provided by default -as part of Flutter quill. +as part of Flutter Quill. Instead, it provides an interface for all the users to provide their implementations for embed blocks. Implementations for image, video, and formula embed blocks are proved in this package -The instructions for using the embed blocks are in the [Usage](#usage) section +The instructions for using the embed blocks are in the [Usage](#-usage) section ### 🔍 Element properties