Skip to content

docs: inline SDK comments, integration guide, README, license#5

Merged
kherembourg merged 5 commits intomainfrom
feat/documentation
Mar 30, 2026
Merged

docs: inline SDK comments, integration guide, README, license#5
kherembourg merged 5 commits intomainfrom
feat/documentation

Conversation

@kherembourg
Copy link
Copy Markdown
Contributor

Summary

  • // PURCHASELY: inline comments on every SDK call across both Android (9 files, 54 lines) and iOS (10 files, 62 lines), with docs links
  • Companion Integration Guide (docs/INTEGRATION_GUIDE.md) — 10-section walkthrough of every SDK feature with dual-platform code snippets, console setup steps, and common pitfalls
  • Marketing README — feature checklist, quick start, architecture overview, placements table
  • MIT License (copyright Purchasely 2026)
  • Contributing Guide — setup, conventions, how to add new SDK features

Documentation structure

README.md              — Public-facing entry point
LICENSE                — MIT
CONTRIBUTING.md        — Developer onboarding
docs/INTEGRATION_GUIDE.md — Feature-by-feature SDK reference

Test plan

  • Verify inline comments don't break builds (both platforms)
  • Review INTEGRATION_GUIDE.md code snippets match actual app code
  • Review README quick start instructions work on a fresh clone

🤖 Generated with Claude Code

kherembourg and others added 4 commits March 30, 2026 18:46
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@kherembourg kherembourg merged commit d9b9f53 into main Mar 30, 2026
2 checks passed
@kherembourg kherembourg deleted the feat/documentation branch March 30, 2026 17:23
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.

1 participant