diff --git a/README.md b/README.md index af0fa29..a55ab8f 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) + +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*: + + + 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