Skip to content

Update readme #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Quinn-With-Two-Ns merged 2 commits into from
Jun 6, 2025
Merged

Update readme #29

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc4f2dd
Update readme
Quinn-With-Two-Ns Jun 4, 2025
e5e3ed5
Update readme
Quinn-With-Two-Ns Jun 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 31 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)

Java SDK for working with [Nexus RPC](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.nexusrpc/nexus-sdk) of the Nexus Java SDK at maven central.

Add *nexus-sdk* as a dependency to your *pom.xml*:

<dependency>
<groupId>io.nexusrpc</groupId>
<artifactId>nexus-sdk</artifactId>
<version>N.N.N</version>
</dependency>

or to *build.gradle*:

compile group: 'io.nexusrpc', name: 'nexus-sdk', version: 'N.N.N'

**⚠️ UNDER DEVELOPMENT ⚠️**
Loading