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 access conditions, the two-step confirmation for destructive tools, and the integration prompt (the docs text, with step 3 taking the SDK version from the release tag or the package registry).
• 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.

Facts checked

Minimum versions, from this repository's manifests:

• React Native 0.76 with the New Architecture — the real floor per the maintainers; peerDependencies still declares 0.60 and the README says so in one line (to be aligned separately) — package.json, android/gradle.properties
• React 16.8.1 — package.json
• iOS 13.0 — qonversion-react-native-sdk.podspec
• Android minSdkVersion 24 — android/gradle.properties

Init and first-call signatures: example/src/App.tsx, example/src/screens/EntitlementsScreen/index.tsx, src/dto/Entitlement.ts.

Versions: npm install carries no version. Latest release on 2026-10-12: 10.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 30 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
• 403 https://www.npmjs.com/package/@qonversion/react-native-sdk — npmjs.com blocks automated requests; the package exists (checked via registry.npmjs.org)
• 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: tools need the apple_ads account feature; campaign changes additionally need the apple_ads:write scope and campaign-management permission (mcp-server#126); React Native 0.76+ with the New Architecture as the floor; 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 React Native SDK: iOS and Android purchases confirmed with the stores, entitlements, and the revenue data behind Apple Ads, A/B tests and analytics.

Current: React Native 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/react-native-sdk --description "Qonversion React Native SDK: iOS and Android purchases confirmed with the stores, entitlements, and the revenue data behind Apple Ads, A/B tests and analytics.".

Maintainer review rounds of 2026-10-13 and 2026-10-14 applied (see the PR comments).

🤖 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: a35050d0-17be-4c82-bacc-98b1adb7958f

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

• README.md:136 / AGENTS.md:108 (major) — "React 16.8.1" next to RN 0.76 is impossible: react-native@0.76 peer-requires react ^18.2.0. The 16.8.1 comes from the stale peerDependencies (same as the 0.60 floor). Use "React 18.2+ (required by RN 0.76)"; we'll fix peerDependencies separately.
• README.md:6 (minor) — "lined up with what App Store Connect reports" — this SDK is iOS + Android: "what the App Store and Google Play report".
• AGENTS.md:30-31 (nit) — a second Qonversion pod more likely causes a version-resolution conflict than duplicate symbols; the advice is right, soften the reason.
• Repo description: OK.

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 16df1a2 — could you take another look?

This repo

• README.md:136 / AGENTS.md:108. React is now "18.2 (required by React Native 0.76)". The note under the table (and the AGENTS line) says peerDependencies still declare React Native 0.60 and React 16.8.1, below the real floors.
• README.md:6. "…lined up with what the App Store and Google Play report".
• AGENTS.md:30-31. The reason is softened: a second Qonversion pod "is likely to end in a version-resolution conflict".

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 (npm) 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 16df1a2 — the round-1 points are fixed (React 18.2 with the peerDependencies-lag note, App Store and Google Play wording, Sandwich pin, Apple Ads, version source). Verified: tag = npm latest = 10.12.0; npm still has the old peerDependencies, so the note is accurate.

One thing I missed in round 1 (already fixed on iOS and Flutter):

1. AGENTS.md:106. example/src/App.tsx is named "the reference for initialization", but App.tsx:66-68 sets Environment.SANDBOX, an entitlements cache lifetime and .setProxyURL('api-eu.qonversion.io') — an agent copying it ships sandbox plus the EU proxy. Suggested:

   example/ — a demo app that runs in the sandbox environment: example/src/App.tsx sets Environment.SANDBOX, an entitlements cache lifetime and a proxy URL, so it is not the reference for initialization — the Initialize snippet above is. example/src/screens/EntitlementsScreen/index.tsx shows the entitlements call.

   And in README.md:128-129: "It runs in the sandbox environment; for your own initialization, use the Quickstart snippet above."

Nit: AGENTS.md:102 — "Environment in the wrappers" isn't true for all wrappers (Flutter uses QEnvironment). Suggest: "In this SDK the enum is Environment (src/dto/enums.ts); read it from the SDK, not from memory."

Once these are in, it's good to merge from your side — no need for another round from me unless something else changes.

---

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.

[Vlada-Q]

@SpertsyanKM round 2 is done in 8dc9a7d:

• AGENTS.md:106. example/ is described as a sandbox demo (Environment.SANDBOX, an entitlements cache lifetime, a proxy URL), so the Initialize snippet is named as the reference; EntitlementsScreen/index.tsx still shows the entitlements call. Your text, as is.
• README.md:128-129. Added: "It runs in the sandbox environment; for your own initialization, use the Quickstart snippet above."
• AGENTS.md:102 (nit). "In this SDK the enum is Environment (src/dto/enums.ts); read it from the SDK, not from memory."
• Apple Ads (non-blocking point). AGENTS.md now uses your wording: "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." The main Apple Ads sentence is still pending Sam's confirmation.
• PR body. The Apple Ads sentence is replaced with your text (mcp-server#126), so the squash commit message is up to date.

Ready to merge. We only have read access here, could you merge it?

[SpertsyanKM]

Re-reviewed 8dc9a7d: all round-2 points are fixed and verified against source. Thanks! Merging.