Skip to content

Commit

Permalink
docs: Update README (#266)
Browse files Browse the repository at this point in the history 
Signed-off-by: CaiJingLong <[email protected]>
  • Loading branch information
@CaiJingLong
CaiJingLong authored Oct 20, 2023
1 parent 1e232a1 commit 235643a
Show file tree
Hide file tree
Showing 6 changed files with 140 additions and 80 deletions.
36 changes: 23 additions & 13 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Compresses image as native plugin (Obj-C/Kotlin). This library works on Android
- [Compressing returns `null`](#compressing-returns-null)
- [About EXIF information](#about-exif-information)
- [Web](#web)
- [About macOS](#about-macos)
- [Platform Features](#platform-features)

## Why don't you use dart to do it
Expand Down Expand Up @@ -358,20 +359,29 @@ About web compatibility: two methods with file will throw an exception when used

[pica]: https://www.npmjs.com/package/pica?activeTab=readme

## About macOS

You need change the minimum deployment target to 10.15.

Open xcode project, select Runner target, and change the value of `macOS Deployment Target` to `10.15`.

And, change the `Podfile`:
Change `platform` to `platform :osx, '10.15'`.

## Platform Features

| Feature | Android | iOS | Web |
| :------------------------- | :-----: | :---: | :---------------------: |
| method: compressWithList | ✅ | ✅ | ✅ |
| method: compressAssetImage | ✅ | ✅ | ✅ |
| method: compressWithFile | ✅ | ✅ | ❌ |
| method: compressAndGetFile | ✅ | ✅ | ❌ |
| format: jpeg | ✅ | ✅ | ✅ |
| format: png | ✅ | ✅ | ✅ |
| format: webp | ✅ | ✅ | [🌐][webp-compatibility] |
| format: heic | ✅ | ✅ | ❌ |
| param: quality | ✅ | ✅ | [🌐][webp-compatibility] |
| param: rotate | ✅ | ✅ | ❌ |
| param: keepExif | ✅ | ✅ | ❌ |
| Feature | Android | iOS | Web | macOS |
| :------------------------- | :-----: | :---: | :---------------------: | :---: |
| method: compressWithList | ✅ | ✅ | ✅ | ✅ |
| method: compressAssetImage | ✅ | ✅ | ✅ | ✅ |
| method: compressWithFile | ✅ | ✅ | ❌ | ✅ |
| method: compressAndGetFile | ✅ | ✅ | ❌ | ✅ |
| format: jpeg | ✅ | ✅ | ✅ | ✅ |
| format: png | ✅ | ✅ | ✅ | ✅ |
| format: webp | ✅ | ✅ | [🌐][webp-compatibility] | ❌ |
| format: heic | ✅ | ✅ | ❌ | ✅ |
| param: quality | ✅ | ✅ | [🌐][webp-compatibility] | ✅ |
| param: rotate | ✅ | ✅ | ❌ | ✅ |
| param: keepExif | ✅ | ✅ | ❌ | ✅ |

[webp-compatibility]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toBlob#browser_compatibility "Browser support"
36 changes: 23 additions & 13 deletions packages/flutter_image_compress/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Compresses image as native plugin (Obj-C/Kotlin). This library works on Android
- [Compressing returns `null`](#compressing-returns-null)
- [About EXIF information](#about-exif-information)
- [Web](#web)
- [About macOS](#about-macos)
- [Platform Features](#platform-features)

## Why don't you use dart to do it
Expand Down Expand Up @@ -358,20 +359,29 @@ About web compatibility: two methods with file will throw an exception when used

[pica]: https://www.npmjs.com/package/pica?activeTab=readme

## About macOS

You need change the minimum deployment target to 10.15.

Open xcode project, select Runner target, and change the value of `macOS Deployment Target` to `10.15`.

And, change the `Podfile`:
Change `platform` to `platform :osx, '10.15'`.

## Platform Features

| Feature | Android | iOS | Web |
| :------------------------- | :-----: | :---: | :---------------------: |
| method: compressWithList | ✅ | ✅ | ✅ |
| method: compressAssetImage | ✅ | ✅ | ✅ |
| method: compressWithFile | ✅ | ✅ | ❌ |
| method: compressAndGetFile | ✅ | ✅ | ❌ |
| format: jpeg | ✅ | ✅ | ✅ |
| format: png | ✅ | ✅ | ✅ |
| format: webp | ✅ | ✅ | [🌐][webp-compatibility] |
| format: heic | ✅ | ✅ | ❌ |
| param: quality | ✅ | ✅ | [🌐][webp-compatibility] |
| param: rotate | ✅ | ✅ | ❌ |
| param: keepExif | ✅ | ✅ | ❌ |
| Feature | Android | iOS | Web | macOS |
| :------------------------- | :-----: | :---: | :---------------------: | :---: |
| method: compressWithList | ✅ | ✅ | ✅ | ✅ |
| method: compressAssetImage | ✅ | ✅ | ✅ | ✅ |
| method: compressWithFile | ✅ | ✅ | ❌ | ✅ |
| method: compressAndGetFile | ✅ | ✅ | ❌ | ✅ |
| format: jpeg | ✅ | ✅ | ✅ | ✅ |
| format: png | ✅ | ✅ | ✅ | ✅ |
| format: webp | ✅ | ✅ | [🌐][webp-compatibility] | ❌ |
| format: heic | ✅ | ✅ | ❌ | ✅ |
| param: quality | ✅ | ✅ | [🌐][webp-compatibility] | ✅ |
| param: rotate | ✅ | ✅ | ❌ | ✅ |
| param: keepExif | ✅ | ✅ | ❌ | ✅ |

[webp-compatibility]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toBlob#browser_compatibility "Browser support"
38 changes: 24 additions & 14 deletions packages/flutter_image_compress_common/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Compresses image as native plugin (Obj-C/Kotlin). This library works on Android
- [Compressing returns `null`](#compressing-returns-null)
- [About EXIF information](#about-exif-information)
- [Web](#web)
- [About macOS](#about-macos)
- [Platform Features](#platform-features)

## Why don't you use dart to do it
Expand Down Expand Up @@ -64,7 +65,7 @@ import 'package:flutter_image_compress/flutter_image_compress.dart';

Use as:

[See full example](https://github.com/fluttercandies/flutter_image_compress/blob/main/example/lib/main.dart)
[See full example](https://github.com/fluttercandies/flutter_image_compress/blob/main/packages/flutter_image_compress/example/lib/main.dart)

There are several ways to use the library api.

Expand Down Expand Up @@ -358,20 +359,29 @@ About web compatibility: two methods with file will throw an exception when used

[pica]: https://www.npmjs.com/package/pica?activeTab=readme

## About macOS

You need change the minimum deployment target to 10.15.

Open xcode project, select Runner target, and change the value of `macOS Deployment Target` to `10.15`.

And, change the `Podfile`:
Change `platform` to `platform :osx, '10.15'`.

## Platform Features

| Feature | Android | iOS | Web |
| :------------------------- | :-----: | :---: | :---------------------: |
| method: compressWithList | ✅ | ✅ | ✅ |
| method: compressAssetImage | ✅ | ✅ | ✅ |
| method: compressWithFile | ✅ | ✅ | ❌ |
| method: compressAndGetFile | ✅ | ✅ | ❌ |
| format: jpeg | ✅ | ✅ | ✅ |
| format: png | ✅ | ✅ | ✅ |
| format: webp | ✅ | ✅ | [🌐][webp-compatibility] |
| format: heic | ✅ | ✅ | ❌ |
| param: quality | ✅ | ✅ | [🌐][webp-compatibility] |
| param: rotate | ✅ | ✅ | ❌ |
| param: keepExif | ✅ | ✅ | ❌ |
| Feature | Android | iOS | Web | macOS |
| :------------------------- | :-----: | :---: | :---------------------: | :---: |
| method: compressWithList | ✅ | ✅ | ✅ | ✅ |
| method: compressAssetImage | ✅ | ✅ | ✅ | ✅ |
| method: compressWithFile | ✅ | ✅ | ❌ | ✅ |
| method: compressAndGetFile | ✅ | ✅ | ❌ | ✅ |
| format: jpeg | ✅ | ✅ | ✅ | ✅ |
| format: png | ✅ | ✅ | ✅ | ✅ |
| format: webp | ✅ | ✅ | [🌐][webp-compatibility] | ❌ |
| format: heic | ✅ | ✅ | ❌ | ✅ |
| param: quality | ✅ | ✅ | [🌐][webp-compatibility] | ✅ |
| param: rotate | ✅ | ✅ | ❌ | ✅ |
| param: keepExif | ✅ | ✅ | ❌ | ✅ |

[webp-compatibility]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toBlob#browser_compatibility "Browser support"
38 changes: 24 additions & 14 deletions packages/flutter_image_compress_macos/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Compresses image as native plugin (Obj-C/Kotlin). This library works on Android
- [Compressing returns `null`](#compressing-returns-null)
- [About EXIF information](#about-exif-information)
- [Web](#web)
- [About macOS](#about-macos)
- [Platform Features](#platform-features)

## Why don't you use dart to do it
Expand Down Expand Up @@ -64,7 +65,7 @@ import 'package:flutter_image_compress/flutter_image_compress.dart';

Use as:

[See full example](https://github.com/fluttercandies/flutter_image_compress/blob/main/example/lib/main.dart)
[See full example](https://github.com/fluttercandies/flutter_image_compress/blob/main/packages/flutter_image_compress/example/lib/main.dart)

There are several ways to use the library api.

Expand Down Expand Up @@ -358,20 +359,29 @@ About web compatibility: two methods with file will throw an exception when used

[pica]: https://www.npmjs.com/package/pica?activeTab=readme

## About macOS

You need change the minimum deployment target to 10.15.

Open xcode project, select Runner target, and change the value of `macOS Deployment Target` to `10.15`.

And, change the `Podfile`:
Change `platform` to `platform :osx, '10.15'`.

## Platform Features

| Feature | Android | iOS | Web |
| :------------------------- | :-----: | :---: | :---------------------: |
| method: compressWithList | ✅ | ✅ | ✅ |
| method: compressAssetImage | ✅ | ✅ | ✅ |
| method: compressWithFile | ✅ | ✅ | ❌ |
| method: compressAndGetFile | ✅ | ✅ | ❌ |
| format: jpeg | ✅ | ✅ | ✅ |
| format: png | ✅ | ✅ | ✅ |
| format: webp | ✅ | ✅ | [🌐][webp-compatibility] |
| format: heic | ✅ | ✅ | ❌ |
| param: quality | ✅ | ✅ | [🌐][webp-compatibility] |
| param: rotate | ✅ | ✅ | ❌ |
| param: keepExif | ✅ | ✅ | ❌ |
| Feature | Android | iOS | Web | macOS |
| :------------------------- | :-----: | :---: | :---------------------: | :---: |
| method: compressWithList | ✅ | ✅ | ✅ | ✅ |
| method: compressAssetImage | ✅ | ✅ | ✅ | ✅ |
| method: compressWithFile | ✅ | ✅ | ❌ | ✅ |
| method: compressAndGetFile | ✅ | ✅ | ❌ | ✅ |
| format: jpeg | ✅ | ✅ | ✅ | ✅ |
| format: png | ✅ | ✅ | ✅ | ✅ |
| format: webp | ✅ | ✅ | [🌐][webp-compatibility] | ❌ |
| format: heic | ✅ | ✅ | ❌ | ✅ |
| param: quality | ✅ | ✅ | [🌐][webp-compatibility] | ✅ |
| param: rotate | ✅ | ✅ | ❌ | ✅ |
| param: keepExif | ✅ | ✅ | ❌ | ✅ |

[webp-compatibility]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toBlob#browser_compatibility "Browser support"
36 changes: 23 additions & 13 deletions packages/flutter_image_compress_platform_interface/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Compresses image as native plugin (Obj-C/Kotlin). This library works on Android
- [Compressing returns `null`](#compressing-returns-null)
- [About EXIF information](#about-exif-information)
- [Web](#web)
- [About macOS](#about-macos)
- [Platform Features](#platform-features)

## Why don't you use dart to do it
Expand Down Expand Up @@ -358,20 +359,29 @@ About web compatibility: two methods with file will throw an exception when used

[pica]: https://www.npmjs.com/package/pica?activeTab=readme

## About macOS

You need change the minimum deployment target to 10.15.

Open xcode project, select Runner target, and change the value of `macOS Deployment Target` to `10.15`.

And, change the `Podfile`:
Change `platform` to `platform :osx, '10.15'`.

## Platform Features

| Feature | Android | iOS | Web |
| :------------------------- | :-----: | :---: | :---------------------: |
| method: compressWithList | ✅ | ✅ | ✅ |
| method: compressAssetImage | ✅ | ✅ | ✅ |
| method: compressWithFile | ✅ | ✅ | ❌ |
| method: compressAndGetFile | ✅ | ✅ | ❌ |
| format: jpeg | ✅ | ✅ | ✅ |
| format: png | ✅ | ✅ | ✅ |
| format: webp | ✅ | ✅ | [🌐][webp-compatibility] |
| format: heic | ✅ | ✅ | ❌ |
| param: quality | ✅ | ✅ | [🌐][webp-compatibility] |
| param: rotate | ✅ | ✅ | ❌ |
| param: keepExif | ✅ | ✅ | ❌ |
| Feature | Android | iOS | Web | macOS |
| :------------------------- | :-----: | :---: | :---------------------: | :---: |
| method: compressWithList | ✅ | ✅ | ✅ | ✅ |
| method: compressAssetImage | ✅ | ✅ | ✅ | ✅ |
| method: compressWithFile | ✅ | ✅ | ❌ | ✅ |
| method: compressAndGetFile | ✅ | ✅ | ❌ | ✅ |
| format: jpeg | ✅ | ✅ | ✅ | ✅ |
| format: png | ✅ | ✅ | ✅ | ✅ |
| format: webp | ✅ | ✅ | [🌐][webp-compatibility] | ❌ |
| format: heic | ✅ | ✅ | ❌ | ✅ |
| param: quality | ✅ | ✅ | [🌐][webp-compatibility] | ✅ |
| param: rotate | ✅ | ✅ | ❌ | ✅ |
| param: keepExif | ✅ | ✅ | ❌ | ✅ |

[webp-compatibility]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toBlob#browser_compatibility "Browser support"
36 changes: 23 additions & 13 deletions packages/flutter_image_compress_web/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Compresses image as native plugin (Obj-C/Kotlin). This library works on Android
- [Compressing returns `null`](#compressing-returns-null)
- [About EXIF information](#about-exif-information)
- [Web](#web)
- [About macOS](#about-macos)
- [Platform Features](#platform-features)

## Why don't you use dart to do it
Expand Down Expand Up @@ -358,20 +359,29 @@ About web compatibility: two methods with file will throw an exception when used

[pica]: https://www.npmjs.com/package/pica?activeTab=readme

## About macOS

You need change the minimum deployment target to 10.15.

Open xcode project, select Runner target, and change the value of `macOS Deployment Target` to `10.15`.

And, change the `Podfile`:
Change `platform` to `platform :osx, '10.15'`.

## Platform Features

| Feature | Android | iOS | Web |
| :------------------------- | :-----: | :---: | :---------------------: |
| method: compressWithList | ✅ | ✅ | ✅ |
| method: compressAssetImage | ✅ | ✅ | ✅ |
| method: compressWithFile | ✅ | ✅ | ❌ |
| method: compressAndGetFile | ✅ | ✅ | ❌ |
| format: jpeg | ✅ | ✅ | ✅ |
| format: png | ✅ | ✅ | ✅ |
| format: webp | ✅ | ✅ | [🌐][webp-compatibility] |
| format: heic | ✅ | ✅ | ❌ |
| param: quality | ✅ | ✅ | [🌐][webp-compatibility] |
| param: rotate | ✅ | ✅ | ❌ |
| param: keepExif | ✅ | ✅ | ❌ |
| Feature | Android | iOS | Web | macOS |
| :------------------------- | :-----: | :---: | :---------------------: | :---: |
| method: compressWithList | ✅ | ✅ | ✅ | ✅ |
| method: compressAssetImage | ✅ | ✅ | ✅ | ✅ |
| method: compressWithFile | ✅ | ✅ | ❌ | ✅ |
| method: compressAndGetFile | ✅ | ✅ | ❌ | ✅ |
| format: jpeg | ✅ | ✅ | ✅ | ✅ |
| format: png | ✅ | ✅ | ✅ | ✅ |
| format: webp | ✅ | ✅ | [🌐][webp-compatibility] | ❌ |
| format: heic | ✅ | ✅ | ❌ | ✅ |
| param: quality | ✅ | ✅ | [🌐][webp-compatibility] | ✅ |
| param: rotate | ✅ | ✅ | ❌ | ✅ |
| param: keepExif | ✅ | ✅ | ❌ | ✅ |

[webp-compatibility]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toBlob#browser_compatibility "Browser support"

0 comments on commit 235643a

Please sign in to comment.