Skip to content

docs: correct the README's requirements, setup and privacy notes - #20

Merged
onamfc merged 1 commit into
mainfrom
docs/readme-accuracy
Oct 28, 2026
Merged

onamfc merged 1 commit into
mainfrom
docs/readme-accuracy

Conversation

@onamfc

@onamfc onamfc commented Oct 27, 2026

Copy link
Copy Markdown
Member

Brings the README in line with what 0.6.0 actually needs and does.

Requirements

The README said Flutter 3.10+, Dart 3.0+, iOS 12.0+ and Android API 21+. The SDK's dependencies set a higher floor:

Was Is Why
Flutter 3.10+ 3.38.1+ The oldest app_links 7.x, device_info_plus 13.1 and package_info_plus 10.1 each require flutter >=3.38.1
Dart 3.0+ 3.10+ Same packages: sdk >=3.10.0
iOS 12.0+ 13.0+ Every accepted app_links version: platform :ios, '13.0'
Android API 21+ API 24+ Every accepted app_links version: minSdk = 24

Checked against the pubspecs on pub.dev for the minimum versions the constraints allow, and against app_links 7.0.0 and 7.2.2's podspec and build.gradle.

Suggested follow-up: pubspec.yaml still declares flutter: '>=3.10.0' and sdk: '>=3.0.0'. Raising them to >=3.38.1 and >=3.10.0 would make pub's error point at the real requirement. It's a metadata change for the next release.

Flutter's built-in deep linking

Since Flutter 3.27 the built-in handler is on by default. Flutter's breaking-change note says apps using app_links must opt out. The README presented it as optional ("if you also use Flutter's built-in deep linking") and gave the iOS value as NO. It's now a Platform Setup step, with the note's snippets (<false/> on iOS).

Quick Start

  • Shows appToken, which 0.6.0 supports and the hosted service requires.
  • Says apiKey is only needed for createLink().

flutter analyze reports no issues on the updated Quick Start against linkforty_flutter 0.6.0.

Privacy

  • Replaced: "No Persistent IDs: uses probabilistic fingerprinting only", which no longer matches the SDK.
  • Now says: no advertising IDs (IDFA/GAID) and no ATT prompt; Android installs are matched by the Play install referrer where available, otherwise by fingerprint.
  • Install ID: the SDK stores the install ID the server assigns, and clearData() removes it.
  • Data collected now lists the platform, the Play install referrer and the optional app-supplied deviceId.

Note

pub.dev shows the README from the published package, so these changes appear there with the next release; GitHub shows them on merge.

- Requirements: Flutter 3.38.1+, Dart 3.10+, iOS 13.0+, Android API 24+.
  Every app_links version the SDK accepts needs iOS 13 and minSdk 24, and the
  oldest needs Flutter 3.38.1 (as do device_info_plus 13.1 and
  package_info_plus 10.1); the README said Flutter 3.10, iOS 12, API 21.
- Flutter's built-in deep linking: since Flutter 3.27 it's on by default and
  conflicts with app_links, so it must be turned off, not only "if you also
  use it". Adds the opt-out snippets from Flutter's breaking-change note to
  Platform Setup (the iOS key takes <false/>, not NO).
- Quick Start: shows appToken, and says apiKey is only needed for createLink.
- Privacy: no advertising IDs is the accurate claim; installs on Android are
  matched by the Play install referrer where available; the SDK stores the
  install ID the server assigns. Data collected now lists the platform, the
  Play install referrer and an optional app-supplied device ID.
- Android setup: minSdk 24 and the Play App Signing fingerprint.
@onamfc
onamfc merged commit c6956d1 into main Oct 28, 2026
4 checks passed
@onamfc
onamfc deleted the docs/readme-accuracy branch October 28, 2026 06:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants