Conversation
…verified 60-second quickstart, and CI/Javadoc badges
This branch has not been deployed
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
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.
Summary
Restructures the README along the lines of the promotion audit: lead with the one-line pitch and the Kotlin hero snippet from the homepage, follow with a quickstart that is copy-pasteable end to end, and complete the badge row.
What changed
CheckoutWorkflowhero snippet, so the README and the site tell the same story.bashblock creates a Gradle project (settings.gradle.kts,build.gradle.kts,Main.kt) via heredocs and runs it. It uses the embedded in-memory SQLite default, the AllOpen plugin that Kotlin adopters need, and quiets engine logs so the output is justHello, world!. The previous, richer signals/waitUntilexample moves to its own section right after.main) and a Javadoc badge next to Maven Central and the license. Dropped the redundant docs and Jackson badges from the row; the Jackson compatibility note stays in the text.Trade-off: the Javadoc badge does not point at javadoc.io yet. javadoc.io resolves artifacts through the legacy
search.maven.orgindex, which currently returns zero results forcom.airbnb.skipper:skipper-coreeven though Central lists 0.8.0 and the Dokka javadoc jar is published. javadoc.io therefore rendersjavadoc: unknownand lands on an empty versions page. The badge links to the site's API reference instead; once the index catches up it can be repointed tohttps://javadoc.io/doc/com.airbnb.skipper/skipper-corein a one-line change.Testing
bashblock from the README verbatim withawkand ran it in a clean directory againstskipper-core:0.8.0from Maven Central (Gradle 9.7.1 wrapper, JDK 21 host, toolchain 17). Output was exactlyHello, world!.factory<GreetingWorkflow>("id")operator andSkipperOpenannotation exist inskipper-coresources.dl.circleci.com/status-badge/.../tree/main.svg, HTTP 200 SVG) and shields.io badge URLs resolve.spotlessCheckis unaffected.