From e9457df5f0ba1aa0e8d2f06ad28055e1fe99bd15 Mon Sep 17 00:00:00 2001 From: Ellet <73608287+EchoEllet@users.noreply.github.com> Date: Sat, 13 Jul 2024 11:08:22 +0300 Subject: [PATCH] docs(readme): fix a few typos and invalid links in extensions package --- flutter_quill_extensions/README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/flutter_quill_extensions/README.md b/flutter_quill_extensions/README.md index 834008bd..20e58687 100644 --- a/flutter_quill_extensions/README.md +++ b/flutter_quill_extensions/README.md @@ -58,7 +58,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 @@ -72,8 +72,8 @@ The package uses the following plugins: Android, iOS, and macOS, we must inform you that you can't pick photos using the camera on a desktop so make sure to 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 then you must set up it, open the page in pub.dev and read +5. [`super_clipboard`](https://pub.dev/packages/super_clipboard) which needs some setup on Android only, is used to + support copying images and pasting them into the editor then you must set up it, 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. @@ -84,10 +84,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 @@ -99,18 +99,18 @@ The minSdkVersion is `23` as `super_clipboard` requires it Start using the package in 3 steps: 1. Be sure to follow the [Installation](#installation) section. -2. This package already include `super_clipboard` and will be used internally in this package, to use it +2. This package already includes `super_clipboard` and will be used internally in this package, to use it in `flutter_quill`, call this function before using any of the widgets or functionalities ```dart FlutterQuillExtensions.useSuperClipboardPlugin(); ``` - `super_clipboard` is comprehensive plugin that provides many clipboard features for reading and writing of rich text, + `super_clipboard` is a comprehensive plugin that provides many clipboard features for reading and writing rich text, images and other formats. Executing this function will allow `flutter_quill` to use modern rich text features to paste HTML and Markdown, - support for Gif files, and other formats. + support for GIF files, and other formats. 3. Set the `embedBuilders` and `embedToolbar` params in configurations of `QuillEditor` and `QuillToolbar` with the values provided by this repository. @@ -140,12 +140,12 @@ Start using the package in 3 steps: ### 📦 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