Skip to content

docs: add README (prerelease draft, pinned to 0.1.1) - #4

Merged
Tomperez98 merged 2 commits into
mainfrom
flossy/java-readme
Jul 2, 2026
Merged

Tomperez98 merged 2 commits into
mainfrom
flossy/java-readme

Conversation

@flossypurse

@flossypurse flossypurse commented Jun 30, 2026 •

Copy link
Copy Markdown
Contributor

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

  • Compiled the quickstart program against io.resonatehq:resonate-sdk-java:0.1.1 on a Java 21 toolchain (compileJava succeeds).
  • Checked every API against the source at the v0.1.1 tag: Resonate.builder().url(..).build(), r.register(Owner::ref), r.run(id, ref, args) → ResonateHandle<R>, handle.result(), ctx.run(ref, arg).await(), r.stop().
  • CLI commands (resonate dev, resonate promises get, resonate tree) checked against the installed CLI.
  • All links resolve; the social handles use the resonatehqio accounts.
  • LICENSE already 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.

@flossypurse
flossypurse marked this pull request as ready for review June 30, 2026 19:23
@Tomperez98
Tomperez98 merged commit 39f6d76 into main Jul 2, 2026
4 checks passed
@Tomperez98
Tomperez98 deleted the flossy/java-readme branch July 2, 2026 16:35
@flossypurse flossypurse mentioned this pull request Jul 14, 2026
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