Skip to content

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

Open
Vlada-Q wants to merge 2 commits into
qonversion:mainfrom
Vlada-Q:marketing/readme-v2
Open

Vlada-Q wants to merge 2 commits into
qonversion:mainfrom
Vlada-Q:marketing/readme-v2

Conversation

@Vlada-Q

@Vlada-Q Vlada-Q commented Oct 12, 2026 •

Copy link
Copy Markdown
Contributor

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.

Facts checked

Minimum versions, from this repository's manifests:

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:

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; 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.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Oct 12, 2026 •

Copy link
Copy Markdown

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: 40e2a0ef-18c7-49ad-b723-2e2cf8d08aab

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.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant