Skip to content

Commit 21a07ab

Browse files
committed
📝 Improve README with various of changes.
1 parent 8af1432 commit 21a07ab

File tree

2 files changed

+34
-12
lines changed

2 files changed

+34
-12
lines changed

README-ZH.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33
[![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.dev/packages/wechat_assets_picker)
44
[![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.dev/packages/wechat_assets_picker)
55
[![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)
6-
[![Build status](https://img.shields.io/github/workflow/status/fluttercandies/flutter_wechat_assets_picker/Build%20test?label=%E7%8A%B6%E6%80%81&logo=github&style=flat-square)](https://github.com/fluttercandies/flutter_wechat_assets_picker/actions?query=workflow%3A%22Build+test%22)
76
[![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)
7+
[![Build status](https://img.shields.io/github/workflow/status/fluttercandies/flutter_wechat_assets_picker/Build%20test?label=%E7%8A%B6%E6%80%81&logo=github&style=flat-square)](https://github.com/fluttercandies/flutter_wechat_assets_picker/actions?query=workflow%3A%22Build+test%22)
8+
[![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)
89
[![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/master/LICENSE)
910
<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>
1011

@@ -17,6 +18,7 @@ Language: [English](README.md) | 中文简体
1718
* [特性](#特性-)
1819
* [截图](#截图-)
1920
* [准备工作](#准备工作-)
21+
* [版本限制](#版本限制)
2022
* [Flutter](#flutter)
2123
* [Android](#android)
2224
* [iOS](#ios)
@@ -40,24 +42,32 @@ Language: [English](README.md) | 中文简体
4042
- [x] 🎶 音频资源支持
4143
- [x] 1️⃣ 单资源模式
4244
- [x] 💱 国际化支持
45+
- [x] ➕ 自定义 widget 构建支持(前置/后置)
4346
- [x] 🗂 自定义路径排序支持
44-
- [x] 📝 自定义文本支持
47+
- [x] 📝 自定义文本构建支持
48+
- [x] ⏳ 自定义筛选规则支持( `photo_manager`
4549
- [x] 🎏 完整的自定义主题
4650
- [x] 💻 支持 MacOS
4751

4852
## 截图 📸
4953

50-
| ![1](screenshots/1.jpg) | ![2](screenshots/2.jpg) | ![3](screenshots/3.jpg) |
51-
| ----------------------- | ----------------------- | ----------------------- |
52-
| ![4](screenshots/4.jpg) | ![5](screenshots/5.jpg) | ![6](screenshots/6.jpg) |
53-
| ![7](screenshots/7.jpg) | ![8](screenshots/8.jpg) | ![9](screenshots/9.jpg) |
54+
| ![1](https://tva1.sinaimg.cn/large/007S8ZIlgy1ggo5plm5wlj30u01t0zp7.jpg) | ![2](https://tva1.sinaimg.cn/large/007S8ZIlgy1ggo5q69848j30u01t04o5.jpg) | ![3](https://tva1.sinaimg.cn/large/007S8ZIlgy1ggo5q60v9qj30u01t07vh.jpg) |
55+
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
56+
| ![4](https://tva1.sinaimg.cn/large/007S8ZIlgy1ggo5q5qe7jj30u01t04qp.jpg) | ![5](https://tva1.sinaimg.cn/large/007S8ZIlgy1ggo5q5jobgj30u01t0ngi.jpg) | ![6](https://tva1.sinaimg.cn/large/007S8ZIlgy1ggo5q5cebej30u01t04a0.jpg) |
57+
| ![7](https://tva1.sinaimg.cn/large/007S8ZIlgy1ggo5q56xuhj30u01t077a.jpg) | ![8](https://tva1.sinaimg.cn/large/007S8ZIlgy1ggo5q50otnj30u01t0kjf.jpg) | ![9](https://tva1.sinaimg.cn/large/007S8ZIlgy1ggo5q4o7x5j30u01t0e81.jpg) |
5458

5559
## 开始前的注意事项 ‼️
5660

5761
尽管该库提供了资源的选择,其仍然要求使用者构建自己的方法来处理显示、上传等操作。如果你在使用该库的过程对某些方法或API有疑问,请运行demo并查看[photo_manager](https://github.com/CaiJingLong/flutter_photo_manager)对相关方法的使用说明。
5862

5963
## 准备工作 🍭
6064

65+
### 版本限制
66+
67+
Flutter SDK:`>=1.17.0`
68+
69+
如果在 `flutter pub get` 时遇到了失败问题,请使用 `dependency_overrides` 解决。
70+
6171
### Flutter
6272

6373
`wechat_assets_picker`添加至`pubspec.yaml`引用。
@@ -79,10 +89,13 @@ import 'package:wechat_assets_picker/wechat_assets_picker.dart';
7989

8090
### Android
8191

92+
依赖要求项目的安卓原生部分整合至 Android embedding v2,更多信息请至 [Upgrading pre 1.12 Android projects](https://github.com/flutter/flutter/wiki/Upgrading-pre-1.12-Android-projects) 查看。
93+
8294
需要声明的权限:`INTERNET`, `READ_EXTERNAL_STORAGE`, `WRITE_EXTERNAL_STORAGE`, `ACCESS_MEDIA_LOCATION`
8395

84-
如果你发现有一些与`Glide`有关的警告日志输出,那么主项目就需要要实现 `AppGlideModule`。比如:
96+
如果你发现有一些与`Glide`有关的警告日志输出,那么主项目就需要实现 `AppGlideModule`。比如:
8597
`example/android/app/build.gradle`:
98+
8699
```gradle
87100
apply plugin: 'com.android.application'
88101
apply plugin: 'kotlin-android'

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[![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)
44
[![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)
55
[![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)
6+
[![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)
67
[![Build status](https://img.shields.io/github/workflow/status/fluttercandies/flutter_wechat_assets_picker/Build%20test?label=CI&logo=github&style=flat-square)](https://github.com/fluttercandies/flutter_wechat_assets_picker/actions?query=workflow%3A%22Build+test%22)
78
[![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)
89
[![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/master/LICENSE)
@@ -17,6 +18,7 @@ An **assets picker** which looks like the one in WeChat, based on `photo_manager
1718
* [Features](#features-)
1819
* [Screenshots](#screenshots-)
1920
* [Preparing for use](#preparing-for-use-)
21+
* [Version constraints](#version-constraints)
2022
* [Flutter](#flutter)
2123
* [Android](#android)
2224
* [iOS](#ios)
@@ -43,22 +45,29 @@ An **assets picker** which looks like the one in WeChat, based on `photo_manager
4345
- [x] ➕ Custom item builder (prepend/append) support
4446
- [x] 🗂 Custom sort path delegate support
4547
- [x] 📝 Custom text delegate support
48+
- [x] ⏳ Custom filter options support ( `photo_manager` )
4649
- [x] 🎏 Custom theme entirely
4750
- [x] 💻 MacOS support
4851

4952
## Screenshots 📸
5053

51-
| ![1](screenshots/1.jpg) | ![2](screenshots/2.jpg) | ![3](screenshots/3.jpg) |
52-
| ----------------------- | ----------------------- | ----------------------- |
53-
| ![4](screenshots/4.jpg) | ![5](screenshots/5.jpg) | ![6](screenshots/6.jpg) |
54-
| ![7](screenshots/7.jpg) | ![8](screenshots/8.jpg) | ![9](screenshots/9.jpg) |
54+
| ![1](https://tva1.sinaimg.cn/large/007S8ZIlgy1ggo5plm5wlj30u01t0zp7.jpg) | ![2](https://tva1.sinaimg.cn/large/007S8ZIlgy1ggo5q69848j30u01t04o5.jpg) | ![3](https://tva1.sinaimg.cn/large/007S8ZIlgy1ggo5q60v9qj30u01t07vh.jpg) |
55+
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
56+
| ![4](https://tva1.sinaimg.cn/large/007S8ZIlgy1ggo5q5qe7jj30u01t04qp.jpg) | ![5](https://tva1.sinaimg.cn/large/007S8ZIlgy1ggo5q5jobgj30u01t0ngi.jpg) | ![6](https://tva1.sinaimg.cn/large/007S8ZIlgy1ggo5q5cebej30u01t04a0.jpg) |
57+
| ![7](https://tva1.sinaimg.cn/large/007S8ZIlgy1ggo5q56xuhj30u01t077a.jpg) | ![8](https://tva1.sinaimg.cn/large/007S8ZIlgy1ggo5q50otnj30u01t0kjf.jpg) | ![9](https://tva1.sinaimg.cn/large/007S8ZIlgy1ggo5q4o7x5j30u01t0e81.jpg) |
5558

5659
## READ THIS FIRST ‼️
5760

5861
Althought the package provide selection for assets, it still require users build their own methods to handle display/upload, etc. If you have any question about how to build it, please run the example or refer to [photo_manager](https://github.com/CaiJingLong/flutter_photo_manager) for API usage.
5962

6063
## Preparing for use 🍭
6164

65+
### Version constraints
66+
67+
Flutter SDK: `>=1.17.0` .
68+
69+
If you got an error about `resolve conflict` when running `flutter pub get` , please use `dependency_overrides` to solve it.
70+
6271
### Flutter
6372

6473
Add `wechat_assets_picker` to `pubspec.yaml` dependencies.
@@ -295,7 +304,7 @@ If you still needs path after requested the `File`, get it through `file.absolut
295304

296305
### Create `AssetEntity` from `File` or `Uint8List` (rawData)
297306

298-
In order to combine this package with camera shooting or something related, there's a wordaround about how to create an `AssetEntity` with `File` or `Uint8List` object.
307+
In order to combine this package with camera shooting or something related, there's a solution about how to create an `AssetEntity` with `File` or `Uint8List` object.
299308

300309
```dart
301310
final File file = your_file; // Your file object

0 commit comments

Comments
 (0)