Repository navigation
docs: add README (prerelease draft, pinned to 0.1.1) - #4
Merged
Merged
Conversation
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
The repo has no README — this adds one, plus a dark/light banner pair for
assets/. It gives early adopters an install snippet, a runnable quickstart, and links to the docs, examples, and community.Shape: banner → CI + Apache-2.0 badges →
# Resonate Java SDK→ pre-release note → an intro paragraph with links (issues, evaluate, examples, concepts, Discord, Journal, X, LinkedIn, YouTube) → Quickstart (install server → add the SDK → write a function → start the server → run → result → what to try) → Documentation → License.Prerelease, pinned to 0.1.1
Every version string — prose, Gradle, Maven — is pinned to
0.1.1, the only release on Maven Central (v0.1.0's publish never landed). The pre-release note stays until the API surface is called stable; nothing here claims GA or 1.0. Java 21+ is called out as a hard requirement (the SDK uses virtual threads).Opened as a draft
This is a draft on purpose — the README is yours to own or co-edit. Happy to hand it off, merge as-is, or revise to taste. Not merging without your call.
What I verified
io.resonatehq:resonate-sdk-java:0.1.1on a Java 21 toolchain (compileJavasucceeds).v0.1.1tag:Resonate.builder().url(..).build(),r.register(Owner::ref),r.run(id, ref, args)→ResonateHandle<R>,handle.result(),ctx.run(ref, arg).await(),r.stop().resonate dev,resonate promises get,resonate tree) checked against the installed CLI.resonatehqioaccounts.LICENSEalready exists at the repo root (Apache-2.0).The Java-specific docs page (
develop/java) is still in review, so the docs link points at the docs root for now.