From 761ff3169cbbdebb6df50418a83596ab231af73a Mon Sep 17 00:00:00 2001 From: Julian Steenbakker Date: Fri, 3 May 2024 14:12:57 +0200 Subject: [PATCH] Update README.md --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index bded6c6f7..9626aba27 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,11 @@ A universal scanner for Flutter based on MLKit. Uses CameraX on Android and AVFoundation on iOS. ## Breaking Changes v5.0.0 - Version 5.0.0 brings some breaking changes. However, some are reverted in version 5.1.0. Please see the list below for all breaking changes, and Changelog.md for a more detailed list. +* ~~The `autoStart` attribute has been removed from the `MobileScannerController`. The controller should be manually started on-demand.~~ (Reverted in version 5.1.0) +* ~~A controller is now required for the `MobileScanner` widget.~~ (Reverted in version 5.1.0) +* ~~The `onDetect` method has been removed from the `MobileScanner` widget. Instead, listen to `MobileScannerController.barcodes` directly.~~ (Reverted in version 5.1.0) * The `width` and `height` of `BarcodeCapture` have been removed, in favor of `size`. * The `raw` attribute is now `Object?` instead of `dynamic`, so that it participates in type promotion. * The `MobileScannerArguments` class has been removed from the public API, as it is an internal type. @@ -20,12 +22,9 @@ Version 5.0.0 brings some breaking changes. However, some are reverted in versio * The `MobileScannerState` enum has been renamed to `MobileScannerAuthorizationState`. * The various `ValueNotifier`s for the camera state have been removed. Use the `value` of the `MobileScannerController` instead. * The `hasTorch` getter has been removed. Instead, use the torch state of the controller's value. - The `TorchState` enum now provides a new value for unavailable flashlights. -~~* The `autoStart` attribute has been removed from the `MobileScannerController`. The controller should be manually started on-demand.~~ (Reverted in version 5.1.0) -~~* A controller is now required for the `MobileScanner` widget.~~ (Reverted in version 5.1.0) +* The `TorchState` enum now provides a new value for unavailable flashlights. * The `onPermissionSet`, `onStart` and `onScannerStarted` methods have been removed from the `MobileScanner` widget. Instead, await `MobileScannerController.start()`. * The `startDelay` has been removed from the `MobileScanner` widget. Instead, use a delay between manual starts of one or more controllers. -~~* The `onDetect` method has been removed from the `MobileScanner` widget. Instead, listen to `MobileScannerController.barcodes` directly.~~ (Reverted in version 5.1.0) * The `overlay` widget of the `MobileScanner` has been replaced by a new property, `overlayBuilder`, which provides the constraints for the overlay. * The torch can no longer be toggled on the web, as this is only available for image tracks and not video tracks. As a result the torch state for the web will always be `TorchState.unavailable`. * The zoom scale can no longer be modified on the web, as this is only available for image tracks and not video tracks. As a result, the zoom scale will always be `1.0`.