docs: refresh README for the example module, R8 keep-rules, and navigation#127
Merged
Conversation
Bring the README current with recently merged work and make it easier to navigate: - Add a contents bar linking the major sections. - Point the quick start at the runnable sdk-example module so readers can run the assembled toolkit end to end with a single Gradle task. - Note the two unpublished modules (sdk-example, sdk-shrink-test) alongside the published-module table. - Document the consumer R8/ProGuard keep-rules shipped under META-INF/proguard, which downstream shrinkers inherit automatically, and list the sdk-shrink-test guard among the build's quality gates.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README had drifted behind recently merged work and was long enough to be hard to scan. This refresh brings it current and improves navigation, with no code changes.
What changed
sdk-examplemodule, so a reader can run the fully assembled toolkit —IoProvider, transport, serde, and a complete pipeline against an embedded server — with./gradlew :sdk-example:run.sdk-exampleand thesdk-shrink-testR8 harness.META-INF/proguard/, which downstream R8 / AGP builds apply automatically, and explains what they protect (the runtime-wired SPI seams and the reflectively-bound HTTP models andTristate). Thesdk-shrink-testguard is also listed among the build's quality gates.Verification
All version and dependency numbers in the README were checked against
gradle/libs.versions.toml,gradle.properties,settings.gradle.kts, and the Gradle wrapper, and were already accurate (Kotlin 2.3.21, Gradle 9.3.1,0.0.1-alpha.1). Documentation-only change; the build is unaffected.