Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[various] Clarify endorsement in READMEs #3404

Merged
merged 7 commits into from Mar 8, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/camera/camera_android/CHANGELOG.md
@@ -1,3 +1,7 @@
## 0.10.5+1

* Clarifies explanation of endorsement in README.

## 0.10.5

* Allows camera to be switched while video recording.
Expand Down
6 changes: 5 additions & 1 deletion packages/camera/camera_android/README.md
Expand Up @@ -5,7 +5,11 @@ The Android implementation of [`camera`][1].
## Usage

This package is [endorsed][2], which means you can simply use `camera`
normally. This package will be automatically included in your app when you do.
normally. This package will be automatically included in your app when you do,
so you do not need to add it to your `pubspec.yaml`.

However, if you `import` this package to use any of its APIs directly, you
should add it to your `pubspec.yaml` as usual.

[1]: https://pub.dev/packages/camera
[2]: https://flutter.dev/docs/development/packages-and-plugins/developing-packages#endorsed-federated-plugin
2 changes: 1 addition & 1 deletion packages/camera/camera_android/pubspec.yaml
Expand Up @@ -2,7 +2,7 @@ name: camera_android
description: Android implementation of the camera plugin.
repository: https://github.com/flutter/packages/tree/main/packages/camera/camera_android
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+camera%22
version: 0.10.5
version: 0.10.5+1

environment:
sdk: ">=2.17.0 <3.0.0"
Expand Down
4 changes: 4 additions & 0 deletions packages/camera/camera_avfoundation/CHANGELOG.md
@@ -1,3 +1,7 @@
## 0.9.13+1

* Clarifies explanation of endorsement in README.

## 0.9.13

* Allows camera to be switched while video recording.
Expand Down
6 changes: 5 additions & 1 deletion packages/camera/camera_avfoundation/README.md
Expand Up @@ -5,7 +5,11 @@ The iOS implementation of [`camera`][1].
## Usage

This package is [endorsed][2], which means you can simply use `camera`
normally. This package will be automatically included in your app when you do.
normally. This package will be automatically included in your app when you do,
so you do not need to add it to your `pubspec.yaml`.

However, if you `import` this package to use any of its APIs directly, you
should add it to your `pubspec.yaml` as usual.

[1]: https://pub.dev/packages/camera
[2]: https://flutter.dev/docs/development/packages-and-plugins/developing-packages#endorsed-federated-plugin
2 changes: 1 addition & 1 deletion packages/camera/camera_avfoundation/pubspec.yaml
Expand Up @@ -2,7 +2,7 @@ name: camera_avfoundation
description: iOS implementation of the camera plugin.
repository: https://github.com/flutter/packages/tree/main/packages/camera/camera_avfoundation
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+camera%22
version: 0.9.13
version: 0.9.13+1

environment:
sdk: '>=2.18.0 <3.0.0'
Expand Down
3 changes: 2 additions & 1 deletion packages/camera/camera_web/CHANGELOG.md
@@ -1,5 +1,6 @@
## NEXT
## 0.3.1+3

* Clarifies explanation of endorsement in README.
* Aligns Dart and Flutter SDK constraints.

## 0.3.1+2
Expand Down
10 changes: 7 additions & 3 deletions packages/camera/camera_web/README.md
Expand Up @@ -10,7 +10,11 @@ The web implementation of [`camera`][camera].

This package is [endorsed](https://flutter.dev/docs/development/packages-and-plugins/developing-packages#endorsed-federated-plugin),
which means you can simply use `camera`
normally. This package will be automatically included in your app when you do.
normally. This package will be automatically included in your app when you do,
so you do not need to add it to your `pubspec.yaml`.

However, if you `import` this package to use any of its APIs directly, you
should add it to your `pubspec.yaml` as usual.

## Example

Expand Down Expand Up @@ -84,13 +88,13 @@ if (kIsWeb) {
}
```

### Video recording
### Video recording

The video recording implementation is backed by [MediaRecorder Web API](https://developer.mozilla.org/en-US/docs/Web/API/MediaRecorder) with the following [browser support](https://caniuse.com/mdn-api_mediarecorder):

![Data on support for the MediaRecorder feature across the major browsers from caniuse.com](https://caniuse.bitsofco.de/image/mediarecorder.png).

A video is recorded in one of the following video MIME types:
A video is recorded in one of the following video MIME types:
- video/webm (e.g. on Chrome or Firefox)
- video/mp4 (e.g. on Safari)

Expand Down
2 changes: 1 addition & 1 deletion packages/camera/camera_web/pubspec.yaml
Expand Up @@ -2,7 +2,7 @@ name: camera_web
description: A Flutter plugin for getting information about and controlling the camera on Web.
repository: https://github.com/flutter/packages/tree/main/packages/camera/camera_web
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+camera%22
version: 0.3.1+2
version: 0.3.1+3

environment:
sdk: ">=2.17.0 <3.0.0"
Expand Down
3 changes: 2 additions & 1 deletion packages/file_selector/file_selector_ios/CHANGELOG.md
@@ -1,5 +1,6 @@
## NEXT
## 0.5.1+1

* Clarifies explanation of endorsement in README.
* Aligns Dart and Flutter SDK constraints.

## 0.5.1
Expand Down
6 changes: 5 additions & 1 deletion packages/file_selector/file_selector_ios/README.md
Expand Up @@ -5,7 +5,11 @@ The iOS implementation of [`file_selector`][1].
## Usage

This package is [endorsed][2], which means you can simply use `file_selector`
normally. This package will be automatically included in your app when you do.
normally. This package will be automatically included in your app when you do,
so you do not need to add it to your `pubspec.yaml`.

However, if you `import` this package to use any of its APIs directly, you
should add it to your `pubspec.yaml` as usual.

[1]: https://pub.dev/packages/file_selector
[2]: https://flutter.dev/docs/development/packages-and-plugins/developing-packages#endorsed-federated-plugin
2 changes: 1 addition & 1 deletion packages/file_selector/file_selector_ios/pubspec.yaml
Expand Up @@ -2,7 +2,7 @@ name: file_selector_ios
description: iOS implementation of the file_selector plugin.
repository: https://github.com/flutter/packages/tree/main/packages/file_selector/file_selector_ios
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+file_selector%22
version: 0.5.1
version: 0.5.1+1

environment:
sdk: ">=2.18.0 <3.0.0"
Expand Down
3 changes: 2 additions & 1 deletion packages/file_selector/file_selector_linux/CHANGELOG.md
@@ -1,5 +1,6 @@
## NEXT
## 0.9.1+2

* Clarifies explanation of endorsement in README.
* Aligns Dart and Flutter SDK constraints.

## 0.9.1+1
Expand Down
6 changes: 5 additions & 1 deletion packages/file_selector/file_selector_linux/README.md
Expand Up @@ -5,7 +5,11 @@ The Linux implementation of [`file_selector`][1].
## Usage

This package is [endorsed][2], which means you can simply use `file_selector`
normally. This package will be automatically included in your app when you do.
normally. This package will be automatically included in your app when you do,
so you do not need to add it to your `pubspec.yaml`.

However, if you `import` this package to use any of its APIs directly, you
should add it to your `pubspec.yaml` as usual.

[1]: https://pub.dev/packages/file_selector
[2]: https://flutter.dev/docs/development/packages-and-plugins/developing-packages#endorsed-federated-plugin
2 changes: 1 addition & 1 deletion packages/file_selector/file_selector_linux/pubspec.yaml
Expand Up @@ -2,7 +2,7 @@ name: file_selector_linux
description: Liunx implementation of the file_selector plugin.
repository: https://github.com/flutter/packages/tree/main/packages/file_selector/file_selector_linux
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+file_selector%22
version: 0.9.1+1
version: 0.9.1+2

environment:
sdk: ">=2.17.0 <3.0.0"
Expand Down
3 changes: 2 additions & 1 deletion packages/file_selector/file_selector_macos/CHANGELOG.md
@@ -1,5 +1,6 @@
## NEXT
## 0.9.0+6

* Clarifies explanation of endorsement in README.
* Aligns Dart and Flutter SDK constraints.

## 0.9.0+5
Expand Down
6 changes: 5 additions & 1 deletion packages/file_selector/file_selector_macos/README.md
Expand Up @@ -5,7 +5,11 @@ The macOS implementation of [`file_selector`][1].
## Usage

This package is [endorsed][2], which means you can simply use `file_selector`
normally. This package will be automatically included in your app when you do.
normally. This package will be automatically included in your app when you do,
so you do not need to add it to your `pubspec.yaml`.

However, if you `import` this package to use any of its APIs directly, you
should add it to your `pubspec.yaml` as usual.

### Entitlements

Expand Down
2 changes: 1 addition & 1 deletion packages/file_selector/file_selector_macos/pubspec.yaml
Expand Up @@ -2,7 +2,7 @@ name: file_selector_macos
description: macOS implementation of the file_selector plugin.
repository: https://github.com/flutter/packages/tree/main/packages/file_selector/file_selector_macos
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+file_selector%22
version: 0.9.0+5
version: 0.9.0+6

environment:
sdk: ">=2.17.0 <3.0.0"
Expand Down
3 changes: 2 additions & 1 deletion packages/file_selector/file_selector_web/CHANGELOG.md
@@ -1,5 +1,6 @@
## NEXT
## 0.9.0+4

* Clarifies explanation of endorsement in README.
* Aligns Dart and Flutter SDK constraints.

## 0.9.0+3
Expand Down
6 changes: 5 additions & 1 deletion packages/file_selector/file_selector_web/README.md
Expand Up @@ -5,7 +5,11 @@ The web implementation of [`file_selector`][1].
## Usage

This package is [endorsed][2], which means you can simply use `file_selector`
normally. This package will be automatically included in your app when you do.
normally. This package will be automatically included in your app when you do,
so you do not need to add it to your `pubspec.yaml`.

However, if you `import` this package to use any of its APIs directly, you
should add it to your `pubspec.yaml` as usual.

[1]: https://pub.dev/packages/file_selector
[2]: https://flutter.dev/docs/development/packages-and-plugins/developing-packages#endorsed-federated-plugin
2 changes: 1 addition & 1 deletion packages/file_selector/file_selector_web/pubspec.yaml
Expand Up @@ -2,7 +2,7 @@ name: file_selector_web
description: Web platform implementation of file_selector
repository: https://github.com/flutter/packages/tree/main/packages/file_selector/file_selector_web
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+file_selector%22
version: 0.9.0+3
version: 0.9.0+4

environment:
sdk: ">=2.17.0 <3.0.0"
Expand Down
3 changes: 2 additions & 1 deletion packages/file_selector/file_selector_windows/CHANGELOG.md
@@ -1,5 +1,6 @@
## NEXT
## 0.9.1+6

* Clarifies explanation of endorsement in README.
* Aligns Dart and Flutter SDK constraints.

## 0.9.1+5
Expand Down
6 changes: 5 additions & 1 deletion packages/file_selector/file_selector_windows/README.md
Expand Up @@ -5,7 +5,11 @@ The Windows implementation of [`file_selector`][1].
## Usage

This package is [endorsed][2], which means you can simply use `file_selector`
normally. This package will be automatically included in your app when you do.
normally. This package will be automatically included in your app when you do,
so you do not need to add it to your `pubspec.yaml`.

However, if you `import` this package to use any of its APIs directly, you
should add it to your `pubspec.yaml` as usual.

[1]: https://pub.dev/packages/file_selector
[2]: https://flutter.dev/docs/development/packages-and-plugins/developing-packages#endorsed-federated-plugin
Expand Up @@ -2,7 +2,7 @@ name: file_selector_windows
description: Windows implementation of the file_selector plugin.
repository: https://github.com/flutter/packages/tree/main/packages/file_selector/file_selector_windows
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+file_selector%22
version: 0.9.1+5
version: 0.9.1+6

environment:
sdk: ">=2.17.0 <3.0.0"
Expand Down
@@ -1,5 +1,6 @@
## NEXT
## 2.4.9

* Clarifies explanation of endorsement in README.
* Aligns Dart and Flutter SDK constraints.

## 2.4.8
Expand Down
Expand Up @@ -8,7 +8,10 @@ The Android implementation of [`google_maps_flutter`][1].

This package is [endorsed][2], which means you can simply use
`google_maps_flutter` normally. This package will be automatically included in
your app when you do.
your app when you do, so you do not need to add it to your `pubspec.yaml`.

However, if you `import` this package to use any of its APIs directly, you
should add it to your `pubspec.yaml` as usual.

## Display Mode

Expand Down
Expand Up @@ -2,7 +2,7 @@ name: google_maps_flutter_android
description: Android implementation of the google_maps_flutter plugin.
repository: https://github.com/flutter/packages/tree/main/packages/google_maps_flutter/google_maps_flutter_android
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+maps%22
version: 2.4.8
version: 2.4.9

environment:
sdk: ">=2.17.0 <3.0.0"
Expand Down
@@ -1,5 +1,6 @@
## NEXT
## 2.2.1

* Clarifies explanation of endorsement in README.
* Aligns Dart and Flutter SDK constraints.

## 2.2.0
Expand Down
Expand Up @@ -6,7 +6,10 @@ The iOS implementation of [`google_maps_flutter`][1].

This package is [endorsed][2], which means you can simply use
`google_maps_flutter` normally. This package will be automatically included in
your app when you do.
your app when you do, so you do not need to add it to your `pubspec.yaml`.

However, if you `import` this package to use any of its APIs directly, you
should add it to your `pubspec.yaml` as usual.

[1]: https://pub.dev/packages/google_maps_flutter
[2]: https://flutter.dev/docs/development/packages-and-plugins/developing-packages#endorsed-federated-plugin
Expand Up @@ -2,7 +2,7 @@ name: google_maps_flutter_ios
description: iOS implementation of the google_maps_flutter plugin.
repository: https://github.com/flutter/packages/tree/main/packages/google_maps_flutter/google_maps_flutter_ios
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+maps%22
version: 2.2.0
version: 2.2.1

environment:
sdk: ">=2.18.0 <3.0.0"
Expand Down
@@ -1,5 +1,6 @@
## NEXT
## 0.4.0+7

* Clarifies explanation of endorsement in README.
* Aligns Dart and Flutter SDK constraints.

## 0.4.0+6
Expand Down
Expand Up @@ -6,9 +6,11 @@ This is an implementation of the [google_maps_flutter](https://pub.dev/packages/

### Depend on the package

This package is not an endorsed implementation of the google_maps_flutter plugin yet, so you'll need to
This package is not an endorsed implementation of the google_maps_flutter plugin yet, so you'll need to
[add it explicitly](https://pub.dev/packages/google_maps_flutter_web/install).

Once you do, you can use the `google_maps_flutter` APIs as you normally would.

### Modify web/index.html

Get an API Key for Google Maps JavaScript API. Get started [here](https://developers.google.com/maps/documentation/javascript/get-api-key).
Expand Down
Expand Up @@ -2,7 +2,7 @@ name: google_maps_flutter_web
description: Web platform implementation of google_maps_flutter
repository: https://github.com/flutter/packages/tree/main/packages/google_maps_flutter/google_maps_flutter_web
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+maps%22
version: 0.4.0+6
version: 0.4.0+7

environment:
sdk: ">=2.17.0 <3.0.0"
Expand Down
@@ -1,5 +1,6 @@
## NEXT
## 6.1.8

* Clarifies explanation of endorsement in README.
* Aligns Dart and Flutter SDK constraints.
* Updates compileSdkVersion to 33.

Expand Down
6 changes: 5 additions & 1 deletion packages/google_sign_in/google_sign_in_android/README.md
Expand Up @@ -5,7 +5,11 @@ The Android implementation of [`google_sign_in`][1].
## Usage

This package is [endorsed][2], which means you can simply use `google_sign_in`
normally. This package will be automatically included in your app when you do.
normally. This package will be automatically included in your app when you do,
so you do not need to add it to your `pubspec.yaml`.

However, if you `import` this package to use any of its APIs directly, you
should add it to your `pubspec.yaml` as usual.

[1]: https://pub.dev/packages/google_sign_in
[2]: https://flutter.dev/docs/development/packages-and-plugins/developing-packages#endorsed-federated-plugin
Expand Up @@ -2,7 +2,7 @@ name: google_sign_in_android
description: Android implementation of the google_sign_in plugin.
repository: https://github.com/flutter/packages/tree/main/packages/google_sign_in/google_sign_in_android
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+google_sign_in%22
version: 6.1.7
version: 6.1.8

environment:
sdk: ">=2.17.0 <3.0.0"
Expand Down
3 changes: 2 additions & 1 deletion packages/google_sign_in/google_sign_in_ios/CHANGELOG.md
@@ -1,5 +1,6 @@
## NEXT
## 5.6.1

* Clarifies explanation of endorsement in README.
* Aligns Dart and Flutter SDK constraints.

## 5.6.0
Expand Down
6 changes: 5 additions & 1 deletion packages/google_sign_in/google_sign_in_ios/README.md
Expand Up @@ -5,7 +5,11 @@ The iOS implementation of [`google_sign_in`][1].
## Usage

This package is [endorsed][2], which means you can simply use `google_sign_in`
normally. This package will be automatically included in your app when you do.
normally. This package will be automatically included in your app when you do,
so you do not need to add it to your `pubspec.yaml`.

However, if you `import` this package to use any of its APIs directly, you
should add it to your `pubspec.yaml` as usual.

[1]: https://pub.dev/packages/google_sign_in
[2]: https://flutter.dev/docs/development/packages-and-plugins/developing-packages#endorsed-federated-plugin