Skip to content

Commit 93cab5f

Browse files
committed
📝 Improve docs with new sections and relative packages
1 parent 4dd9ad0 commit 93cab5f

File tree

2 files changed

+43
-12
lines changed

2 files changed

+43
-12
lines changed

README-ZH.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,7 @@ that can be found in the LICENSE file. -->
1818

1919
Language: [English](README.md) | 中文
2020

21-
基于 **微信 UI** 的 Flutter 图片选择器(同时支持视频和音频)。
22-
该插件基于 [photo_manager][photo_manager pub] 实现资源相关功能,
23-
[extended_image][extended_image pub] 用于查看图片,
24-
[provider][provider pub] 用于协助管理选择器的状态。
21+
基于 **微信 UI** 的 Flutter **图片选择器(同时支持视频和音频)**
2522

2623
当前的界面设计基于的微信版本:**8.3.x**
2724
界面更新将在微信版本更新后随时进行跟进。
@@ -32,11 +29,27 @@ Language: [English](README.md) | 中文
3229

3330
查看 [迁移指南][] 了解如何从破坏性改动中迁移为可用代码。
3431

32+
## 主要使用的 package
33+
34+
该插件基于这些优秀的 package 构建:
35+
36+
| Name | Features |
37+
|:-------------------------------------|:--------------|
38+
| [photo_manager][photo_manager pub] | 资源的基础抽象和管理。 |
39+
| [extended_image][extended_image pub] | 以熟悉的操作预览所有资源。 |
40+
| [provider][provider pub] | 协助选择器管理器内部状态。 |
41+
| [video_player][video_player pub] | 播放对应的视频和音频。 |
42+
43+
这些 package 在该插件中的实现已相对稳定。
44+
如果你在使用中发现于它们相关的问题,
45+
请先在本插件的问题跟踪中报告相关问题。
46+
3547
<details>
3648
<summary>目录列表</summary>
3749

3850
<!-- TOC -->
3951
* [Flutter WeChat Assets Picker](#flutter-wechat-assets-picker)
52+
* [主要使用的 package](#主要使用的-package)
4053
* [特性 ✨](#特性-)
4154
* [特别提醒 📝](#特别提醒-)
4255
* [项目展柜 🖼️](#项目展柜-)
@@ -92,7 +105,7 @@ Language: [English](README.md) | 中文
92105
1. HEIF (HEIC) 图片支持获取和转换,但是它们的显示依托于 Flutter 的图片解析。
93106
在此 issue 中 [flutter/flutter#20522](https://github.com/flutter/flutter/issues/20522) 有所说明。
94107
若要用于显示,请使用 `entity.file``AssetEntityImage` 进行处理。
95-
2. 由于 iOS 和 macOS 的系统限制,在获取音频时只能获取应用沙盒环境内的音频
108+
2. 由于 iOS 和 macOS 的系统限制,在获取音频时只能获取应用沙盒环境内的音频
96109

97110
## 项目展柜 🖼️
98111

@@ -204,6 +217,7 @@ import 'package:wechat_assets_picker/wechat_assets_picker.dart';
204217
```ruby
205218
platform :ios, '11.0'
206219
```
220+
如果该行以 `#` (注释) 开头,请把 `#` 删除。
207221
2. 将以下内容添加至 `Info.plist`
208222
```
209223
<key>NSAppTransportSecurity</key>
@@ -221,6 +235,7 @@ import 'package:wechat_assets_picker/wechat_assets_picker.dart';
221235
```Podfile
222236
platform :osx, '10.15'
223237
```
238+
如果该行以 `#` (注释) 开头,请把 `#` 删除。
224239
2. 使用 **Xcode** 打开 `macos/Runner.xcworkspace`
225240
接着将 macOS 的最低构建版本提升至 **10.15**
226241
3.[iOS](#iOS) 一样,添加相同的内容到 `Info.plist` 里。
@@ -508,6 +523,7 @@ W/Glide (21133): Failed to find GeneratedAppGlideModule.
508523
[photo_manager pub]: https://pub.flutter-io.cn/packages/photo_manager
509524
[extended_image pub]: https://pub.flutter-io.cn/packages/extended_image
510525
[provider pub]: https://pub.flutter-io.cn/packages/provider
526+
[video_player pub]: https://pub.flutter-io.cn/packages/video_player
511527
[wechat_camera_picker pub]: https://pub.flutter-io.cn/packages/wechat_camera_picker
512528
[迁移指南]: https://github.com/fluttercandies/flutter_wechat_assets_picker/blob/main/guides/migration_guide.md
513529
[photo_manager API 文档]: https://pub.flutter-io.cn/documentation/photo_manager/latest/

README.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,32 +14,44 @@ that can be found in the LICENSE file. -->
1414
[![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)
1515

1616
[![Awesome Flutter](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/Solido/awesome-flutter)
17-
<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>
17+
[![Flutter Candies QQ群](https://pub.idqqimg.com/wpa/images/group.png)](https://jq.qq.com/?_wv=1027&k=5bcc0gy)
1818

1919
Language: English | [中文](README-ZH.md)
2020

21-
An image picker (also with videos and audios)
21+
An **image picker (also with videos and audios)**
2222
for Flutter projects based on the WeChat's UI.
23-
The package is using
24-
[photo_manager][photo_manager pub] for asset implementation,
25-
[extended_image][extended_image pub] for image preview,
26-
and [provider][provider pub] to help manage the state of the picker.
2723

2824
Current WeChat version that UI based on: **8.3.x**
2925
UI designs will be updated following the WeChat update in anytime.
3026

3127
To take a photo or a video for assets,
3228
please check the detailed usage in the example,
3329
and head over to [wechat_camera_picker][wechat_camera_picker pub].
34-
The package is a standalone extension that need to be used with combination.
30+
The package is a standalone extension that can to be used with combination.
3531

3632
See the [Migration Guide][] to learn how to migrate between breaking changes.
3733

34+
## Package credits
35+
36+
The package is built from these wonderful packages.
37+
38+
| Name | Features |
39+
|:-------------------------------------|:-----------------------------------------------------|
40+
| [photo_manager][photo_manager pub] | The basic abstractions and management for assets. |
41+
| [extended_image][extended_image pub] | Preview assets with expected behaviors. |
42+
| [provider][provider pub] | Helps to manage the interaction state of the picker. |
43+
| [video_player][video_player pub] | Plays videos and audios correspondingly. |
44+
45+
Their implementation should be relatively stable in the package.
46+
If you've found any issues related to them when using the picker,
47+
submit issues to our issue tracker first.
48+
3849
<details>
3950
<summary>Table of content</summary>
4051

4152
<!-- TOC -->
4253
* [Flutter WeChat Assets Picker](#flutter-wechat-assets-picker)
54+
* [Package credits](#package-credits)
4355
* [Features ✨](#features-)
4456
* [Notes 📝](#notes-)
4557
* [Projects using this plugin 🖼️](#projects-using-this-plugin-)
@@ -211,6 +223,7 @@ consider declare only relevant permission in your apps, more specifically:
211223
```Podfile
212224
platform :ios, '11.0'
213225
```
226+
Remove the `#` heading if the line starts with it.
214227
2. Add the following content to `Info.plist`.
215228
```
216229
<key>NSAppTransportSecurity</key>
@@ -229,6 +242,7 @@ consider declare only relevant permission in your apps, more specifically:
229242
```ruby
230243
platform :osx, '10.15'
231244
```
245+
Remove the `#` heading if the line starts with it.
232246
2. Set the minimum deployment target of the macOS to *10.15*.
233247
Use XCode to open `macos/Runner.xcworkspace` .
234248
3. Follow the [iOS](#iOS) instructions and modify `Info.plist` accordingly.
@@ -579,6 +593,7 @@ such as [IntelliJ IDEA](https://www.jetbrains.com/idea/?from=fluttercandies).
579593
[photo_manager pub]: https://pub.dev/packages/photo_manager
580594
[extended_image pub]: https://pub.dev/packages/extended_image
581595
[provider pub]: https://pub.dev/packages/provider
596+
[video_player pub]: https://pub.dev/packages/video_player
582597
[wechat_camera_picker pub]: https://pub.dev/packages/wechat_camera_picker
583598
[Migration Guide]: https://github.com/fluttercandies/flutter_wechat_assets_picker/blob/main/guides/migration_guide.md
584599
[photo_manager's API docs]: https://pub.dev/documentation/photo_manager/latest/

0 commit comments

Comments
 (0)