From bc4f2dd103a5605ac34172fe80a85f25108c4369 Mon Sep 17 00:00:00 2001 From: Quinn Klassen Date: Wed, 4 Jun 2025 13:29:05 -0700 Subject: [PATCH 1/2] Update readme --- README.md | 33 +++++++++++++++++++++++++++++++-- 1 file changed, 31 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index af0fa29..20c058f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,34 @@ # Nexus Java SDK -Java SDK for working with Nexus RPC. +[![Java Docs](https://img.shields.io/badge/Java_Docs-red)](https://javadoc.io/doc/io.nexusrpc/nexus-sdk/latest/index.html) +[![Continuous Integration](https://github.com/nexus-rpc/sdk-java/actions/workflows/ci.yml/badge.svg)](https://github.com/nexus-rpc/sdk-java/actions/workflows/ci.yml) + +Package for working with the Nexus [HTTP API](https://github.com/nexus-rpc/api). + +## What is Nexus? + +Nexus is a synchronous RPC protocol. Arbitrary length operations are modelled on top of a set of pre-defined synchronous RPCs. + +A Nexus caller calls a handler. The handler may respond inline or return a reference for a future, asynchronous +operation. The caller can cancel an asynchronous operation, check for its outcome, or fetch its current state. The +caller can also specify a callback URL, which the handler uses to asynchronously deliver the result of an operation when it is ready. + +## Supported Java runtimes +* Java 1.8+ + +## Build configuration + +[Find the latest release](https://search.maven.org/artifact/io.temporal/temporal-sdk) of the Temporal Java SDK at maven central. + +Add *temporal-sdk* as a dependency to your *pom.xml*: + + + io.nexusrpc + nexus-sdk + N.N.N + + +or to *build.gradle*: + + compile group: 'io.nexusrpc', name: 'nexus-sdk', version: 'N.N.N' -**⚠️ UNDER DEVELOPMENT ⚠️** \ No newline at end of file From e5e3ed5c47d42a43f896ea8d091d5b93a7ee2126 Mon Sep 17 00:00:00 2001 From: Quinn Klassen Date: Wed, 4 Jun 2025 13:43:43 -0700 Subject: [PATCH 2/2] Update readme --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 20c058f..a55ab8f 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Java Docs](https://img.shields.io/badge/Java_Docs-red)](https://javadoc.io/doc/io.nexusrpc/nexus-sdk/latest/index.html) [![Continuous Integration](https://github.com/nexus-rpc/sdk-java/actions/workflows/ci.yml/badge.svg)](https://github.com/nexus-rpc/sdk-java/actions/workflows/ci.yml) -Package for working with the Nexus [HTTP API](https://github.com/nexus-rpc/api). +Java SDK for working with [Nexus RPC](https://github.com/nexus-rpc/api). ## What is Nexus? @@ -18,9 +18,9 @@ caller can also specify a callback URL, which the handler uses to asynchronously ## Build configuration -[Find the latest release](https://search.maven.org/artifact/io.temporal/temporal-sdk) of the Temporal Java SDK at maven central. +[Find the latest release](https://search.maven.org/artifact/io.nexusrpc/nexus-sdk) of the Nexus Java SDK at maven central. -Add *temporal-sdk* as a dependency to your *pom.xml*: +Add *nexus-sdk* as a dependency to your *pom.xml*: io.nexusrpc