Repository navigation
docs(readme): update plugin documentation for SwiftPM, Android SDK 36, and API accuracy - #910
Merged
Merged
Conversation
…, and API accuracy
Collaborator
Author
|
@pumano : Could you review these updates I made after your SPM changes? |
Collaborator
|
Looks good to me 👍 |
Collaborator
Author
|
@pumano : branch off latest |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📌 Overview
This PR audits and updates all 24
README.mdfiles, 6 packageexample/README.mdfiles, and 4pubspec.yamldescriptions across the monorepo to align the documentation with the current Dart, Android (Kotlin/Gradle), and iOS (Swift Package Manager) implementations. It replaces obsolete CocoaPods workarounds with SwiftPM setup and resource bundle instructions, updates Android SDK requirements to API 36 with Kotlin DSL (build.gradle.kts) snippets, clarifiesModelManagerremote model downloading behavior, completes the GenAI plugin documentation, and fixes code snippets and typos.🛠 Key Changes
Root, Umbrella, Commons & Example App Documentation
README.md: Added theCommon APIstable (google_mlkit_commons), updated iOS requirements to Swift Package Manager (Swift 5.9,d-date/google-mlkit-swiftpm9.0.2), updated AndroidtargetSdkVersion/compileSdkVersionto36with per-pluginminSdkVersionnotes (21,24,26), added the general Production Disclaimer, and formatted thecamera_android/flutter/flutter#145961note.packages/google_ml_kit/README.md: Synced feature tables (Common APIs), clarified which packagesgoogle_ml_kitre-exports vs. standalone packages (google_mlkit_document_scanner,google_mlkit_subject_segmentation), updated iOS SwiftPM and Android SDK 36 requirements, and synced the migration and camera streaming sections.packages/google_mlkit_commons/README.md: AddedInputImage.fromBitmap(...)andManaging remote models (ModelManager)usage sections, fixed camera stream snippet variables (camera,controller) andResolutionPreset.high, updated the iOS Swift source link (MLKVisionImage+FlutterPlugin.swift), and updated iOS/Android requirements.packages/example/README.md: Added iOS ML Kit resource bundle download instructions (./download_mlkit_bundles.sh), Android configuration notes (minSdk = 26,camera_android), and integration test instructions (integration_test/ml_kit_integration_test.dart).Vision & Natural Language Plugin READMEs
packages/google_mlkit_barcode_scanning/README.md: Replaced CocoaPods instructions with SwiftPM setup (-ObjC,-all_load), updated Android SDK to 36, and documentedBarcode.rawBytesandBarcodeFormatusage.packages/google_mlkit_digital_ink_recognition/README.md: Updated iOS setup for SwiftPM andMLKitDigitalInkRecognition_resource.bundle, addedSupported languagessection, added tip forimport 'package:flutter/material.dart' hide Ink;, clarifiedStrokePoint.t(intmilliseconds), and documented that remote models must be downloaded before callingrecognize().packages/google_mlkit_document_scanner/README.md: Updated Android SDK to 36 and added missingawait documentScanner.scanDocument()andDocumentScanningResult(result.pdf,result.images) usage snippet.packages/google_mlkit_entity_extraction/README.md: Updated iOS setup for SwiftPM, updated Android SDK to 36, fixedannotateText()snippet to useEntityAnnotation.text,Entity.rawValue, andEntityTypesubclasses (DateTimeEntity,FlightNumberEntity,MoneyEntity), and clarified auto-download vs.EntityExtractorModelManager.packages/google_mlkit_face_detection/README.md: Updated iOS setup for SwiftPM andGoogleMVFaceDetectorResources.bundle, updated Android SDK to 36, and documented allFaceDetectorOptionsfields.packages/google_mlkit_face_mesh_detection/README.md: Updated Android SDK to 36 and expandedFaceMeshDetectorusage (FaceMeshDetectorOptions,points,triangles,contours).packages/google_mlkit_image_labeling/README.md: Updated iOS setup for SwiftPM (MLKitImageLabelingResources.bundle,MLKitObjectDetectionCommonResources.bundle), addedandroidResources { noCompress ... }in Groovy and Kotlin DSL (build.gradle.kts), documented#if canImport(MLKitLinkFirebase)on iOS, and clarified pre-downloading Firebase models.packages/google_mlkit_language_id/README.md: Updated iOS setup for SwiftPM, updated Android SDK to 36, and documentedund(LanguageIdentifier.undeterminedLanguageCode).packages/google_mlkit_object_detection/README.md: Updated iOS setup for SwiftPM (MLKitObjectDetectionResources.bundle,MLKitObjectDetectionCommonResources.bundle), addedandroidResources { noCompress ... }in Groovy and Kotlin DSL (build.gradle.kts), documented optionalconfidenceThresholdandmaximumLabelsPerObjectparameters, and noted#if canImport(MLKitLinkFirebase)on iOS.packages/google_mlkit_pose_detection/README.md: Updated iOS setup for SwiftPM (MLKitPoseDetectionFastResources.bundle,MLKitPoseDetectionAccurateResources.bundle,MLKitPoseDetectionCommonResources.bundle,MLKitXenoResources.bundle) with physical device GPU/Metal note, updated Android SDK to 36, and documentedPoseDetectionModelandPoseLandmark.likelihood.packages/google_mlkit_selfie_segmentation/README.md: Updated iOS setup for SwiftPM (MLKitSegmentationSelfieResources.bundle,MLKitSegmentationCommonResources.bundle,MLKitXenoResources.bundle) with physical device GPU/Metal note, updated Android SDK to 36, and documentedSegmenterModeandSegmentationMaskfields.packages/google_mlkit_smart_reply/README.md: Updated iOS setup for SwiftPM (PredictOnDeviceResource.bundle), updated Android SDK to 36, addedSupported languages(English only), and documentedclearConversation().packages/google_mlkit_subject_segmentation/README.md: Added top-level Beta Android-only notice,### iOSsection underRequirements, updated Android SDK to 36, and expandedSubjectSegmenterusage to showforegroundBitmap,foregroundConfidenceMask, and per-subject fields.packages/google_mlkit_text_recognition/README.md: Updated iOS setup for SwiftPM OCR bundles (LatinOCRResources.bundle,ChineseOCRResources.bundle,DevanagariOCRResources.bundle,JapaneseOCRResources.bundle,KoreanOCRResources.bundle), added Kotlin DSL (build.gradle.kts) script dependencies, and noted Android-onlyconfidence,angle, andsymbolsfields.packages/google_mlkit_translation/README.md: Updated iOS setup for SwiftPM (MLKitTranslate_resource.bundle), updated Android SDK to 36, and documentedisWifiRequiredand auto-download behavior intranslateText().GenAI Plugin READMEs & Missing
example/README.mdFilespackages/google_mlkit_genai_summarization/README.md: Added Beta Android-only notice, restored fullPLEASE READ THISsection, added### iOSrequirements section, documented all enum options, and added Android native implementation notes.packages/google_mlkit_genai_proofreading/README.md: Added Beta Android-only notice, restored fullPLEASE READ THISsection, added### iOSrequirements section, documented all enum options, and added Android native implementation notes.packages/google_mlkit_genai_rewriting/README.md: Added Beta Android-only notice, restored fullPLEASE READ THISsection, added### iOSrequirements section, documented all enum options, and added Android native implementation notes.packages/google_mlkit_genai_image_description/README.md: Added Beta Android-only notice, restored fullPLEASE READ THISsection, added### iOSrequirements section, documented'file','bytes', andinputImage.toJson()inputs, and added Android native implementation notes.packages/google_mlkit_genai_speech_recognition/README.md: Added Alpha Android-only notice, restored fullPLEASE READ THISsection, added### iOSrequirements section, and documented current Android native implementation status.packages/google_mlkit_genai_prompt/README.md: Added Alpha Android-only notice, restored fullPLEASE READ THISsection, added### iOSrequirements section, documented'file','bytes', andinputImage.toJson()multimodal inputs, and documented current Android native implementation status.packages/google_mlkit_genai_image_description/example/README.md: Added missing package example README linking topackages/example.packages/google_mlkit_genai_prompt/example/README.md: Added missing package example README linking topackages/example.packages/google_mlkit_genai_rewriting/example/README.md: Added missing package example README linking topackages/example.packages/google_mlkit_genai_speech_recognition/example/README.md: Added missing package example README linking topackages/example.packages/google_mlkit_genai_proofreading/example/README.md: Standardized heading to## Example app.packages/google_mlkit_genai_summarization/example/README.md: Standardized heading to## Example app.Package
pubspec.yamlDescriptionspackages/google_mlkit_commons/pubspec.yaml: Fixed grammar in package description.packages/google_mlkit_entity_extraction/pubspec.yaml: Fixed grammar (to recognize specific entities within static text).packages/google_mlkit_selfie_segmentation/pubspec.yaml: Fixed typo (the background from users within a scene).packages/google_mlkit_subject_segmentation/pubspec.yaml: Fixed punctuation and standardized wording (Google's ML Kit Subject Segmentation API).🧪 Verification & Testing
.bundlenames againstpackages/example/ios/download_mlkit_bundles.shandd-date/google-mlkit-swiftpm9.0.2.minSdkVersion,targetSdkVersion,compileSdkVersion, and native ML Kit artifact versions against pluginbuild.gradlefiles.