README v2 and AGENTS.md: quickstart first, docs links, agent guidance

[Vlada-Q]

Summary

Files: README.md, AGENTS.md.

• Header without the landing page: one paragraph on what Qonversion is and what this repository holds; four badges (version, package manager, license, platforms), each linking to where the value can be checked.
• Quickstart in three steps within the first 50 lines: install → initialize → first call (checkEntitlements / entitlements). The mode is named out loud, with a link to Analytics Mode.
• Five links into the docs: Welcome, platform setup, Quick start, API reference, For agents.
• What this SDK does: what the package does, worded as how it works rather than as a promise.
• For agents: the docs MCP server, markdown versions of pages, llms.txt, the Qonversion MCP server with the Apple Ads read/write split, the two-step confirmation for destructive tools, and the integration prompt (same text as in the docs).
• Requirements from code: minimum versions taken from the manifests in this repository (see Facts checked).
• AGENTS.md for coding agents: how to get the current version instead of one from memory, install, init, first call, docs as markdown, MCP, and what an agent must not do without the human saying yes (keys, mode, live project configuration, destructive MCP tools, environment).

Removed on purpose: the Analytics / A/B Experiments / Integrations / Why Qonversion? sections (they duplicate the website and push the install below the fold); long platform guides → a link into the docs; all images except the header.

AGENTS.md Requirements aligned with the README table (macOS 10.15 and Android 23 — the draft still said 13.0 and 21).

Facts checked

Minimum versions, from this repository's manifests:

• Flutter 3.0.0 · Dart >=2.15.0 <4.0.0 — pubspec.yaml
• iOS 13.0 — ios/qonversion_flutter.podspec
• macOS 10.15 — macos/qonversion_flutter.podspec
• Android minSdkVersion 23: the plugin manifest says 21, but it depends on io.qonversion:sandwich, which declares 23 — android/build.gradle

Init and first-call signatures: example/lib/main.dart, example/lib/screens/entitlements_screen.dart, lib/src/dto/entitlement.dart.

Versions: flutter pub add carries no version. Latest release on 2026-10-12: 11.12.0.

Header image

The approved header (logo and platform list, no positioning text) ships in this PR as .github/assets/sdk-header.png, referenced by a one-line <img> tag on line 1 with a relative path, which GitHub, npm and pub.dev all resolve. The quickstart line count does not move.

Links

All 29 URLs in these files checked with curl -sI -L on 2026-10-12: 27 return 200, the rest are expected:

• 401 https://mcp.qonversion.io/mcp — OAuth endpoint of the MCP server, expected without a token
• 405 https://documentation.qonversion.io/mcp — the docs MCP endpoint does not answer GET, it speaks MCP

LICENSE exists in this repository (hygiene PRs merged 2026-10-09/10). docs/for-agents is live.

Review

Four independent reviews in the marketing hub (product, marketing, QA, brand), two iterations. Maintainer answers of 2026-10-09 applied here: Apple Ads in MCP: reading is on for all accounts, changing campaigns is a closed beta per account; the discard_* docs-gap note removed from AGENTS.md.

Reviewer: @SpertsyanKM — the review request cannot be set from a fork, hence the mention.

Repository description (settings, not a file)

The repository description shown under the name on GitHub is a setting, so it cannot be part of this PR. Proposed text to set when merging, so the description, the README header and the docs say the same thing:

Qonversion Flutter SDK: iOS and Android purchases confirmed with the stores, entitlements, and the revenue data behind Apple Ads, A/B tests and analytics.

Current: Flutter SDK for cross-platform in-app purchase and subscription infrastructure, revenue analytics, engagement automation, and integrations

One command for a maintainer: gh repo edit qonversion/flutter-sdk --description "Qonversion Flutter SDK: iOS and Android purchases confirmed with the stores, entitlements, and the revenue data behind Apple Ads, A/B tests and analytics.".

🤖 Generated with Claude Code

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

• Configuration used: Repository: qonversion/coderabbit/.coderabbit.yaml
• Review profile: ASSERTIVE
• Plan: Advanced
• Run ID: b6fbbcf9-332b-4650-b7d3-2f691324d4c5

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

_{Comment @coderabbitai help to get the list of available commands.}

[SpertsyanKM]

Thanks, Vlada — snippets, minimum versions, pins, links and the MCP destructive-tool flow check out against main. Changes needed before merge:

This repo

• AGENTS.md:101 (major) — Flutter's enum is QEnvironment (lib/src/dto/environment.dart:1), not Environment.
• AGENTS.md:105 (major) — example/lib/main.dart hardcodes QEnvironment.sandbox and a cache lifetime (main.dart:51-57), against the file's own Environment rule. Name the AGENTS snippet as the reference; note the example runs in sandbox.
• README.md:5-6 (minor) — "App Store Connect" copied from iOS; "with what the stores report".
• README.md:140 / AGENTS.md:109 (nit) — minSdkVersion 21 is declared in android/build.gradle:36, not a manifest.
• AGENTS.md:31 (nit) — the plugin pins QonversionSandwich 7.14.0 exactly, which pins the iOS SDK; reword.
• Repo description: macOS is a declared platform (pubspec, macos podspec) — "iOS, Android and macOS purchases confirmed with the stores, …".

Shared with the other README v2 / AGENTS.md PRs

• Apple Ads availability — my earlier guidance is outdated, sorry. After 2026-10-09, mcp-server #126 (DEV-1480) removed the separate write beta: there is no apple_ads_write account gate any more (mcp-server/internal/tools/apple_ads_write.go:134). Writes need the apple_ads account feature, the apple_ads:write scope, a dashboard member with campaign-management permission and Apple org write access, and can be switched off server-side. "Closed beta — ask support to switch it on" sends agents the wrong way. Until Sam finalises the Apple Ads docs, please use neutral wording, e.g.: "Apple Ads tools need the feature on your account (404 otherwise); campaign changes additionally need the apple_ads:write scope and a team member with campaign-management permission — check get_apple_ads_connection_status."
• AGENTS.md "If the three disagree, the docs page wins". For the version the docs page lags (iOS page says 6.17.0, Flutter 11.11.0, Unity 9.10.0 and "2018.3", Android 9.+, Cordova still lists cordova-ios 6.x; Web/RN pages name no version). Make the release tag / package registry authoritative for the version, docs for API usage, and tell the agent to report a mismatch. Same for the integration prompt line "use the SDK version the docs name".

[Vlada-Q]

@SpertsyanKM thanks for the review. All points are addressed in bf52008 — could you take another look?

This repo

• AGENTS.md:101 (enum). "In this plugin the enum is QEnvironment."
• AGENTS.md:105 (example). example/ is described as running in the sandbox (QEnvironment.sandbox and a cache lifetime in main.dart), so the Initialize snippet is named as the reference. README "Sample app" notes the sandbox too.
• README.md:5-6. "…lined up with what the stores report".
• README.md:140 / AGENTS.md:109. minSdkVersion 21 is attributed to the plugin's android/build.gradle, not a manifest.
• AGENTS.md:31 (pin). "the plugin pins QonversionSandwich 7.14.0 exactly, that pins the iOS SDK, and a second copy breaks resolution".

Shared with the other README v2 / AGENTS.md PRs

• Apple Ads availability. "Closed beta", "ask support to switch it on" and "per account on request" are gone from README (For agents) and AGENTS.md. The wording from your review is applied as is: "Apple Ads tools need the feature on your account (404 otherwise); campaign changes additionally need the apple_ads:write scope and a team member with campaign-management permission — check get_apple_ads_connection_status." AGENTS.md adds one sentence: a refused Apple Ads call means missing access, not a broken server — do not retry or work around it, tell the human. This wording is pending Sam's confirmation; it will be updated when he finalises the Apple Ads docs.
• Source of the version. "If the three disagree, the docs page wins" is replaced: the release tag and the package registry (pub.dev) are the source for the version, the docs page for install steps and API usage; on a version mismatch the agent uses the tag/registry and tells the human. The integration prompt in the README (step 3) now says to take the version from the latest release tag or the package registry, not from the docs page, and to report a disagreement.

Repo description is left to you, as agreed. Not merging from our side.

[SpertsyanKM]

Re-reviewed bf52008 — all round-1 points are fixed (QEnvironment, example runs in sandbox and is not the init reference, "what the stores report", minSdk 21 location, Sandwich 7.14.0 pin wording, Apple Ads, version source). Verified: latest tag = pub.dev = pubspec = 11.12.0; the README sample-app description matches example/lib/screens/*; docs links and anchors resolve.

Approving. Feel free to merge once the PR body is updated (see below). I'll set the repo description (with macOS) on our side.

---

Shared across all nine README v2 / AGENTS.md PRs

• PR body before squash-merge. The body still says reading Apple Ads "is on for all accounts" and changing campaigns "is a closed beta per account". Both are outdated (mcp-server#126). The body becomes the squash commit message, so please update that sentence, or replace the commit body when merging, e.g.: "Apple Ads in MCP: tools need the apple_ads account feature; campaign changes additionally need the apple_ads:write scope and campaign-management permission (mcp-server#126)."
• "A refused Apple Ads call means missing access … do not retry" (AGENTS.md). Slightly too absolute: get_apple_ads_connection_status can report campaign_management.state: unknown (permission snapshot not landed yet — try later), and an Apple authorization can need reauthorization. Suggested: "A refused Apple Ads call usually means missing access or an Apple authorization that needs attention, not a broken server: call get_apple_ads_connection_status, do not work around it, and tell the human what it reports." Non-blocking; can go together with Sam's final Apple Ads wording.