[camerax] Update README to encourage users to opt in (#6352)

Modify README to encourage users to opt into `camera_android_camerax` to start ramping up usage before changing it to the default plugin implementation on Android.
flutter · Mar 19, 2024 · 23e56af · 23e56af
1 parent bb247f7
commit 23e56af
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 15 deletions.
diff --git a/packages/camera/camera_android_camerax/CHANGELOG.md b/packages/camera/camera_android_camerax/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.6.0+1
+
+* Updates `README.md` to encourage developers to opt into this implementation of the camera plugin.
+
 ## 0.6.0
 
 * Implements `setFocusMode`, which makes this plugin reach feature parity with camera_android.

diff --git a/packages/camera/camera_android_camerax/README.md b/packages/camera/camera_android_camerax/README.md
@@ -2,26 +2,23 @@
 
 An Android implementation of [`camera`][1] that uses the [CameraX library][2].
 
-*Note*: This package is under development, so please note the
-[missing features and limitations](#limitations), but
-otherwise feel free to try out the current implementation and provide any
-feedback by filing issues under [`flutter/flutter`][5] with `[camerax]` in
-the title, which will be actively triaged.
+*Note*: This implementation will become the default implementation of `camera`
+on Android by May 2024, so **we strongly encourage you to opt into it**
+by using [the instructions](#usage) below. If any of [the limitations](#limitations)
+prevent you from using `camera_android_camerax` or if you run into any problems,
+please report these issues under [`flutter/flutter`][5] with `[camerax]` in
+the title.
 
 ## Usage
 
-This package is [non-endorsed][3]; the endorsed Android implementation of `camera`
-is [`camera_android`][4]. To use this implementation of the plugin instead of
-`camera_android`, you will need to specify it in your `pubspec.yaml` file as a
-dependency in addition to `camera`:
+To use this plugin instead of [`camera_android`][4], run
 
-```yaml
-dependencies:
-  # ...along with your other dependencies
-  camera: ^0.10.4
-  camera_android_camerax: ^0.5.0
+```sh
+$ flutter pub add camera_android_camerax
 ```
 
+from your project's root directory.
+
 ## Limitations
 
 ### 240p resolution configuration for video recording

diff --git a/packages/camera/camera_android_camerax/pubspec.yaml b/packages/camera/camera_android_camerax/pubspec.yaml
@@ -2,7 +2,7 @@ name: camera_android_camerax
 description: Android implementation of the camera plugin using the CameraX library.
 repository: https://github.com/flutter/packages/tree/main/packages/camera/camera_android_camerax
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+camera%22
-version: 0.6.0
+version: 0.6.0+1
 
 environment:
   sdk: ^3.1.0