Skip to content

Update the README install and requirements sections - #54

Merged
jrosendahl-opt merged 1 commit into
masterfrom
fix/readme-install
Nov 4, 2026
Merged

jrosendahl-opt merged 1 commit into
masterfrom
fix/readme-install

Conversation

@jrosendahl-opt

@jrosendahl-opt jrosendahl-opt commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Why

The README's install section used an outdated Gradle setup, fenced Groovy as Kotlin, and left the version as a placeholder. Nothing said what an app needs to use the SDK, including the INTERNET permission the SDK doesn't declare. The jitci badge shows a red ✖, and the demo section described a DCN, slug and download path the demos no longer use.

Add a Requirements section (minSdk 23, compileSdk 34 and AGP 8.1.1 from
the SDK's AndroidX dependencies, JDK 17, Kotlin 2.0, and the INTERNET
permission, which the SDK doesn't declare). Show the JitPack repository
in settings.gradle's dependencyResolutionManagement, fence Groovy as
groovy with Kotlin DSL equivalents, and pin the dependency to v1.2.0.

Replace the jitci badge, which shows a failure, with the JitPack release
badge. Use na.edge.optable.co in the config example. Fix the demo section:
the demos use tenant prebidtest and slug android-sdk, include a Prebid
integration, and build the SDK from source unless useReleaseSdk=true.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@jrosendahl-opt
jrosendahl-opt requested review from a team as code owners November 3, 2026 20:16
@jrosendahl-opt
jrosendahl-opt merged commit ef69a7d into master Nov 4, 2026
3 checks passed
@jrosendahl-opt
jrosendahl-opt deleted the fix/readme-install branch November 4, 2026 16:16
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