Skip to content

docs: remove stale README sections and sample permission#677

Merged
imSzukala merged 3 commits into
masterfrom
readme-cleanup-stale-sections
Jun 17, 2026
Merged

docs: remove stale README sections and sample permission#677
imSzukala merged 3 commits into
masterfrom
readme-cleanup-stale-sections

Conversation

@imSzukala

Copy link
Copy Markdown
Contributor

What

Cleans up outdated/redundant content in the README, verified against the actually published SDK AAR (not just the repo docs).

  • Remove the ProGuard section. The published intercom-sdk-base AAR already bundles a consumer proguard.txt containing the exact keep rules the README told users to add manually (-keep class io.intercom.android.**, -keep class com.intercom.**) plus additional -dontwarn/-keep rules. AAR consumer rules are auto-merged into the consuming app's R8 config, so the manual instructions were redundant. The OkHttp/Okio/Retrofit note was also stale.
  • Update the Transitive Dependencies example from Glide to Coil. The SDK migrated off Glide to Coil (2.7.0); the Glide 3.x/4.x example was misleading.
  • Remove the READ_EXTERNAL_STORAGE guidance. Deprecated/ignored for media since Android 13 (API 33), and the SDK AAR no longer declares it. Kept the accurate INTERNET and VIBRATE subsections.
  • Drop READ_EXTERNAL_STORAGE from the sample app manifest for consistency.

Left unchanged (verified accurate)

  • minSdk 23, version 18.3.0, INTERNET-by-default, and all installation/setup content.

Testing

Docs + manifest only — no code or build changes.

🤖 Generated with Claude Code

imSzukala and others added 3 commits June 16, 2026 16:26
- Remove the ProGuard section: the published AAR already bundles consumer
  ProGuard rules with the same keep rules, so manual setup is redundant.
- Update Transitive Dependencies example from Glide to Coil, matching the
  SDK's current image-loading dependency.
- Remove READ_EXTERNAL_STORAGE guidance: deprecated/ignored for media since
  Android 13, and the SDK no longer declares it.
- Drop READ_EXTERNAL_STORAGE from the sample app manifest for consistency.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@imSzukala imSzukala merged commit 94da6c7 into master Jun 17, 2026
3 checks passed
@imSzukala imSzukala deleted the readme-cleanup-stale-sections branch June 17, 2026 08:29
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