📝 Improve documents

Author: AlexV525

CHANGELOG.md

@@ -481,7 +481,7 @@ To know more about breaking changes, see [Migration Guide][].
 
 - Make widgets constant.
 - Remove system ui overlays update.
-- Migrate files to compatible with Flutter `1.20.0` .
+- Migrate files to compatible with Flutter `1.20.0`.
 - Sync analysis options.
 
 ## 4.1.0+2
@@ -506,23 +506,23 @@ To know more about breaking changes, see [Migration Guide][].
 
 ### Breaking changes
 
-- `TextDelegate` -> `AssetsPickerTextDelegate` .
+- `TextDelegate` -> `AssetsPickerTextDelegate`.
 
 ## 3.0.0+1
 
 - Constraint dependencies version.
 
 ## 3.0.0
 
-- Add `FilterOptionGroup`. Fix #41 .
-- Add `SpecialPickerType`. Fix #37 .
-- Add custom item build mode. Fix #39 .
+- Add `FilterOptionGroup`. (#41)
+- Add `SpecialPickerType`. (#37)
+- Add custom item build mode. (#39)
 
 ## 2.2.1
 
-- Introduce `ColorScheme` for theme details. Fixed #32 .
+- Introduce `ColorScheme` for theme details. (#32)
 - Enhance RTL compatibility.
-- Enlarge select indicator's size. Related to #33 .
+- Enlarge select indicator's size. (#33)
 
 ## 2.2.0+2
 
@@ -534,7 +534,7 @@ To know more about breaking changes, see [Migration Guide][].
 
 ## 2.2.0
 
-- A brand new example.
+- A brand-new example.
 - Add `SortPathDelegate`.
 - Using zoom page transition for viewer.
 - Slightly add padding to viewer's assets list view.
@@ -547,14 +547,14 @@ To know more about breaking changes, see [Migration Guide][].
 ## 2.1.0
 
 - Add present english text delegate.
-- Refactored theme constructor and getter with theme capability #22 .
-- Update color scheme usage for assets grid #23 .
-- Update picker viewer style for apple OS.
-- Fix bottom bar disappearing on apple os when it's single asset mode.
+- Refactored theme constructor and getter with theme capability. (#22)
+- Update color scheme usage for assets grid. (#23)
+- Update picker viewer style for Apple OS.
+- Fix bottom bar disappearing on Apple OS when it's single asset mode.
 
 ## 2.0.2
 
-- Fix audio paused accidentally when the app is launching on Android #18 .
+- Fix audio paused accidentally when the app is launching on Android. (#18)
 
 ## 2.0.1
 
@@ -574,11 +574,11 @@ To know more about breaking changes, see [Migration Guide][].
 ## 1.7.0
 
 - Hide detail display when video start to play.
-- Switch to `ExtendedImageGesturePageView`. Fix #16 .
+- Switch to `ExtendedImageGesturePageView`. (#16)
 - Add fully theme support.
-- Add MacOS support.
-- Add delay for the first init method to prevent stuck in page routing. Fix #13 .
-- Update widgets style on iOS. Fix #14 .
+- Add macOS support.
+- Add delay for the first init method to prevent stuck in page routing. (#13)
+- Update widgets style on iOS. (#14)
 - Fix state of the example not updated after the result was returned without input method activated.
 
 ## 1.6.0

README-ZH.md

@@ -4,15 +4,15 @@ that can be found in the LICENSE file. -->
 
 # Flutter WeChat Assets Picker
 
-[![pub package](https://img.shields.io/pub/v/wechat_assets_picker?color=42a012&label=%E7%A8%B3%E5%AE%9A%E7%89%88&logo=dart&style=flat-square)](https://pub.flutter-io.cn/packages/wechat_assets_picker)
-[![pub package](https://img.shields.io/pub/v/wechat_assets_picker?color=42a012&include_prereleases&label=%E5%BC%80%E5%8F%91%E7%89%88&logo=dart&style=flat-square)](https://pub.flutter-io.cn/packages/wechat_assets_picker)
+[![pub package](https://img.shields.io/pub/v/wechat_assets_picker?label=%E7%A8%B3%E5%AE%9A%E7%89%88&logo=dart&style=flat-square)](https://pub.flutter-io.cn/packages/wechat_assets_picker)
+[![pub package](https://img.shields.io/pub/v/wechat_assets_picker?color=9d00ff&include_prereleases&label=%E5%BC%80%E5%8F%91%E7%89%88&logo=dart&style=flat-square)](https://pub.flutter-io.cn/packages/wechat_assets_picker)
 [![Build status](https://img.shields.io/github/actions/workflow/status/fluttercandies/flutter_wechat_assets_picker/runnable.yml?branch=main&label=CI&logo=github&style=flat-square)](https://github.com/fluttercandies/flutter_wechat_assets_picker/actions/workflows/runnable.yml)
 [![CodeFactor](https://img.shields.io/codefactor/grade/github/fluttercandies/flutter_wechat_assets_picker?label=%E4%BB%A3%E7%A0%81%E8%B4%A8%E9%87%8F&logo=codefactor&logoColor=%23ffffff&style=flat-square)](https://www.codefactor.io/repository/github/fluttercandies/flutter_wechat_assets_picker)
 [![GitHub license](https://img.shields.io/github/license/fluttercandies/flutter_wechat_assets_picker?label=%E5%8D%8F%E8%AE%AE&style=flat-square)](https://github.com/fluttercandies/flutter_wechat_assets_picker/blob/main/LICENSE)
 
-[![Awesome Flutter](https://img.shields.io/badge/Awesome-Flutter-blue.svg?longCache=true&style=flat-square)](https://github.com/Solido/awesome-flutter)
 [![GitHub stars](https://img.shields.io/github/stars/fluttercandies/flutter_wechat_assets_picker?logo=github&style=flat-square)](https://github.com/fluttercandies/flutter_wechat_assets_picker/stargazers)
 [![GitHub forks](https://img.shields.io/github/forks/fluttercandies/flutter_wechat_assets_picker?logo=github&style=flat-square)](https://github.com/fluttercandies/flutter_wechat_assets_picker/network)
+[![Awesome Flutter](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/Solido/awesome-flutter)
 <a target="_blank" href="https://jq.qq.com/?_wv=1027&k=5bcc0gy"><img border="0" src="https://pub.idqqimg.com/wpa/images/group.png" alt="FlutterCandies" title="FlutterCandies"></a>
 
 Language: [English](README.md) | 中文
@@ -32,35 +32,39 @@ Language: [English](README.md) | 中文
 你可以通过 PR 提交你的自定义实现。更多信息请参考
 [贡献自定义实现](example/lib/customs/CONTRIBUTING.md) 。
 
-## 目录 🗂
-
-* [迁移指南](#迁移指南-%EF%B8%8F)
-* [特性](#特性-)
-* [截图](#截图-)
-* [准备工作](#准备工作-)
-  * [版本兼容](#版本兼容)
-  * [Flutter](#flutter)
-  * [Android](#android)
-    * [权限](#权限)
-  * [iOS](#ios)
-  * [macOS](#macos)
-* [使用方法](#使用方法-)
-  * [简单的使用方法](#简单的使用方法)
-  * [更详细的使用方法](#更详细的使用方法)
-  * [国际化](#国际化)
-  * [使用自定义代理](#使用自定义代理)
-  * [展示选中的资源](#展示选中的资源)
-  * [注册资源变化回调](#注册资源变化回调)
-  * [自定义类型或 UI](#自定义类型或-ui)
-* [常见问题](#常见问题-)
-  * [Execution failed for task ':photo_manager:compileDebugKotlin'](#execution-failed-for-task-photo_managercompiledebugkotlin)
-  * [如何获取资源的路径以进行上传或编辑等操作的整合？](#如何获取资源的路径以进行上传或编辑等操作的整合)
-  * [从 `File` 或 `Uint8List` 创建 `AssetEntity` 的方法](#从-file-或-uint8list-创建-assetentity-的方法)
-  * [控制台提示 'Failed to find GeneratedAppGlideModule'](#控制台提示-failed-to-find-generatedappglidemodule)
-
-## 迁移指南 ♻️
-
-查看 [迁移指南][]。
+查看 [迁移指南][] 了解如何从破坏性改动中迁移为可用代码。
+
+<!-- TOC -->
+* [Flutter WeChat Assets Picker](#flutter-wechat-assets-picker)
+  * [特性 ✨](#特性-)
+  * [截图 📸](#截图-)
+  * [开始前的注意事项 ‼️](#开始前的注意事项-)
+  * [准备工作 🍭](#准备工作-)
+    * [版本兼容](#版本兼容)
+    * [Flutter](#flutter)
+    * [Android](#android)
+      * [权限](#权限)
+    * [iOS](#ios)
+    * [macOS](#macos)
+  * [使用方法 📖](#使用方法-)
+    * [简单的使用方法](#简单的使用方法)
+    * [更详细的使用方法](#更详细的使用方法)
+    * [国际化](#国际化)
+    * [使用自定义代理](#使用自定义代理)
+      * [一般的调用选择情况](#一般的调用选择情况)
+        * [多选资源](#多选资源)
+        * [单选资源](#单选资源)
+      * [自定义选择器](#自定义选择器)
+    * [展示选中的资源](#展示选中的资源)
+    * [注册资源变化回调](#注册资源变化回调)
+    * [自定义类型或 UI](#自定义类型或-ui)
+  * [常见问题 ❔](#常见问题-)
+    * [Execution failed for task ':photo_manager:compileDebugKotlin'](#execution-failed-for-task---photomanager--compiledebugkotlin)
+    * [如何获取资源的路径以进行上传或编辑等操作的整合？](#如何获取资源的路径以进行上传或编辑等操作的整合)
+    * [从 `File` 或 `Uint8List` 创建 `AssetEntity` 的方法](#从-file-或-uint8list-创建-assetentity-的方法)
+    * [控制台提示 'Failed to find GeneratedAppGlideModule'](#控制台提示--failed-to-find-generatedappglidemodule)
+  * [致谢](#致谢)
+<!-- TOC -->
 
 ## 特性 ✨
 
@@ -175,12 +179,12 @@ import 'package:wechat_assets_picker/wechat_assets_picker.dart';
 
 ### iOS
 
-1. 在 `ios/Podfile` 中指定最低构建版本至 **9.0**。
+1. 在 `ios/Podfile` 中指定最低构建版本至 **1.0**。
    ```ruby
-   platform :ios, '9.0'
+   platform :ios, '11.0'
    ```
-2. 将以下内容添加至 `info.plist`。
-```plist
+2. 将以下内容添加至 `Info.plist`。
+```
 <key>NSAppTransportSecurity</key>
 <dict>
 	<key>NSAllowsArbitraryLoads</key>
@@ -200,7 +204,7 @@ import 'package:wechat_assets_picker/wechat_assets_picker.dart';
    接着根据下面的截图将最低构建版本提升至 **10.15**。
 3. ![step 1](https://tva1.sinaimg.cn/large/007S8ZIlgy1ghw67v4yk4j30qy0b50u0.jpg)
 4. ![step 2](https://tva1.sinaimg.cn/large/007S8ZIlgy1ghw67vd3f2j30jv04zgm5.jpg)
-5. 与 iOS 一样，添加相同的内容到 `info.plist` 里。
+5. 与 iOS 一样，添加相同的内容到 `Info.plist` 里。
 
 ## 使用方法 📖
 

README.md

@@ -5,14 +5,14 @@ that can be found in the LICENSE file. -->
 # Flutter WeChat Assets Picker
 
 [![pub package](https://img.shields.io/pub/v/wechat_assets_picker?logo=dart&label=stable&style=flat-square)](https://pub.dev/packages/wechat_assets_picker)
-[![pub package](https://img.shields.io/pub/v/wechat_assets_picker?color=42a012&include_prereleases&label=dev&logo=dart&style=flat-square)](https://pub.dev/packages/wechat_assets_picker)
+[![pub package](https://img.shields.io/pub/v/wechat_assets_picker?color=9d00ff&include_prereleases&label=dev&logo=dart&style=flat-square)](https://pub.dev/packages/wechat_assets_picker)
 [![Build status](https://img.shields.io/github/actions/workflow/status/fluttercandies/flutter_wechat_assets_picker/runnable.yml?branch=main&label=CI&logo=github&style=flat-square)](https://github.com/fluttercandies/flutter_wechat_assets_picker/actions/workflows/runnable.yml)
 [![CodeFactor](https://img.shields.io/codefactor/grade/github/fluttercandies/flutter_wechat_assets_picker?logo=codefactor&logoColor=%23ffffff&style=flat-square)](https://www.codefactor.io/repository/github/fluttercandies/flutter_wechat_assets_picker)
 [![GitHub license](https://img.shields.io/github/license/fluttercandies/flutter_wechat_assets_picker?style=flat-square)](https://github.com/fluttercandies/flutter_wechat_assets_picker/blob/main/LICENSE)
 
-[![Awesome Flutter](https://img.shields.io/badge/Awesome-Flutter-blue.svg?longCache=true&style=flat-square)](https://github.com/Solido/awesome-flutter)
 [![GitHub stars](https://img.shields.io/github/stars/fluttercandies/flutter_wechat_assets_picker?logo=github&style=flat-square)](https://github.com/fluttercandies/flutter_wechat_assets_picker/stargazers)
 [![GitHub forks](https://img.shields.io/github/forks/fluttercandies/flutter_wechat_assets_picker?logo=github&style=flat-square)](https://github.com/fluttercandies/flutter_wechat_assets_picker/network)
+[![Awesome Flutter](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/Solido/awesome-flutter)
 <a target="_blank" href="https://jq.qq.com/?_wv=1027&k=5bcc0gy"><img border="0" src="https://pub.idqqimg.com/wpa/images/group.png" alt="FlutterCandies" title="FlutterCandies"></a>
 
 Language: English | [中文](README-ZH.md)
@@ -32,35 +32,40 @@ and head over to
 Current WeChat version that UI based on: **8.x**
 UI designs will be updated following the WeChat update in anytime.
 
-## Category 🗂
-
-* [Migration Guide](#migration-guide-)
-* [Features](#features-)
-* [Screenshots](#screenshots-)
-* [Preparing for use](#preparing-for-use-)
-  * [Versions compatibility](#versions-compatibility)
-  * [Flutter](#flutter)
-  * [Android](#android)
-    * [Permissions](#permissions)
-  * [iOS](#ios)
-  * [macOS](#macos)
-* [Usage](#usage-)
-  * [Simple usage](#simple-usage)
-  * [Detailed usage](#detailed-usage)
-  * [Localizations](#localizations)
-  * [Using custom delegate](#using-custom-delegate)
-  * [Display selected assets](#display-selected-assets)
-  * [Register assets change observe callback](#register-assets-change-observe-callback)
-  * [Customize with your own type or UI](#customize-with-your-own-type-or-ui)
-* [Frequently asked question](#frequently-asked-question-)
-  * [Execution failed for task ':photo_manager:compileDebugKotlin'](#execution-failed-for-task-photo_managercompiledebugkotlin)
-  * [How can I get path from the `AssetEntity` to integrate with `File` object, upload or edit?](#how-can-i-get-path-from-the-assetentity-to-integrate-with-file-object-upload-or-edit)
-  * [Create `AssetEntity` from `File` or `Uint8List` (rawData)](#create-assetentity-from-file-or-uint8list-rawdata)
-  * [Console warning 'Failed to find GeneratedAppGlideModule'](#glide-warning-failed-to-find-generatedappglidemodule)
-
-## Migration Guide ♻️
-
-See [Migration Guide][].
+See the [Migration Guide][] to learn how to migrate between breaking changes.
+
+<!-- TOC -->
+* [Flutter WeChat Assets Picker](#flutter-wechat-assets-picker)
+  * [Features ✨](#features-)
+  * [Screenshots 📸](#screenshots-)
+  * [READ THIS FIRST ‼️](#read-this-first-)
+  * [Preparing for use 🍭](#preparing-for-use-)
+    * [Versions compatibility](#versions-compatibility)
+    * [Flutter](#flutter)
+    * [Android](#android)
+      * [Permissions](#permissions)
+    * [iOS](#ios)
+    * [macOS](#macos)
+  * [Usage 📖](#usage-)
+    * [Simple usage](#simple-usage)
+    * [Detailed usage](#detailed-usage)
+    * [Localizations](#localizations)
+    * [Using custom delegate](#using-custom-delegate)
+      * [Regular picking](#regular-picking)
+        * [Multiple assets picking](#multiple-assets-picking)
+        * [Single asset picking](#single-asset-picking)
+      * [Custom pickers](#custom-pickers)
+    * [Display selected assets](#display-selected-assets)
+    * [Register assets change observe callback](#register-assets-change-observe-callback)
+    * [Customize with your own type or UI](#customize-with-your-own-type-or-ui)
+  * [Frequently asked question ❔](#frequently-asked-question-)
+    * [Execution failed for task ':photo_manager:compileDebugKotlin'](#execution-failed-for-task---photomanager--compiledebugkotlin)
+    * [How can I get path from the `AssetEntity` to integrate with `File` object, upload or edit?](#how-can-i-get-path-from-the-assetentity-to-integrate-with-file-object-upload-or-edit)
+    * [Create `AssetEntity` from `File` or `Uint8List` (rawData)](#create-assetentity-from-file-or-uint8list--rawdata-)
+    * [Glide warning 'Failed to find GeneratedAppGlideModule'](#glide-warning--failed-to-find-generatedappglidemodule)
+  * [Contributors ✨](#contributors-)
+  * [Credits](#credits)
+<!-- TOC -->
 
 ## Features ✨
 
@@ -175,13 +180,13 @@ consider removing relevant permission in your apps, more specifically:
 
 ### iOS
 
-1. Platform version has to be at least *9.0*.
+1. Platform version has to be at least *11.0*.
    Modify `ios/Podfile` and update accordingly.
    ```ruby
-   platform :ios, '9.0'
+   platform :ios, '11.0'
    ```
-2. Add the following content to `info.plist`.
-```plist
+2. Add the following content to `Info.plist`.
+```
 <key>NSAppTransportSecurity</key>
 <dict>
 	<key>NSAllowsArbitraryLoads</key>
@@ -202,7 +207,7 @@ consider removing relevant permission in your apps, more specifically:
    Use XCode to open `macos/Runner.xcworkspace` .
 3. ![step 1](https://tva1.sinaimg.cn/large/007S8ZIlgy1ghw67v4yk4j30qy0b50u0.jpg)
 4. ![step 2](https://tva1.sinaimg.cn/large/007S8ZIlgy1ghw67vd3f2j30jv04zgm5.jpg)
-5. Follow the iOS instructions and modify `info.plist` accordingly.
+5. Follow the iOS instructions and modify `Info.plist` accordingly.
 
 ## Usage 📖
 
@@ -463,7 +468,7 @@ This project follows the
 [all-contributors](https://github.com/all-contributors/all-contributors) specification.
 Contributions of any kind welcomed!!
 
-## Acknowledgement
+## Credits
 
 > Every aspect of IntelliJ IDEA has been designed to maximize developer productivity.
 Together, intelligent coding assistance and ergonomic design make development not only productive but also enjoyable.

guides/migration_guide.md

@@ -18,7 +18,8 @@ This document gathered all breaking changes and migrations requirement between m
 
 ### Summary
 
-Delegates extending `AssetPickerBuilderDelegate` that implements `selectAsset` should add the `index` argument to its signature.
+Delegates extending `AssetPickerBuilderDelegate` that implements `selectAsset`
+should add the `index` argument to its signature.
 
 ### Details