Skip to content

Commit

Permalink
Update Readme with links to docs and examples. (#1119)
Browse files Browse the repository at this point in the history
  • Loading branch information
scottf authored Apr 11, 2024
1 parent 7861084 commit 20cbd5c
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

### A [Java](http://java.com) client for the [NATS messaging system](https://nats.io).

**Current Release**: 2.17.6   **Current Snapshot**: 2.17.7-SNAPSHOT
**Current Release**: 2.17.6   **Current Snapshot**: 2.17.7-SNAPSHOT

[![License Apache 2](https://img.shields.io/badge/License-Apache2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.nats/jnats/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.nats/jnats)
Expand All @@ -13,7 +13,12 @@
[![Build Main Badge](https://github.com/nats-io/nats.java/actions/workflows/build-main.yml/badge.svg?event=push)](https://github.com/nats-io/nats.java/actions/workflows/build-main.yml)
[![Release Badge](https://github.com/nats-io/nats.java/actions/workflows/build-release.yml/badge.svg?event=release)](https://github.com/nats-io/nats.java/actions/workflows/build-release.yml)

**Check out [NATS by example](https://natsbyexample.com) - An evolving collection of runnable, cross-client reference examples for NATS.**
The [**API**](https://javadoc.io/doc/io.nats/jnats/latest/index.html) is simple to use and highly performant.

**Check out [NATS by Example](https://natsbyexample.com) - An evolving collection of runnable, cross-client reference examples for NATS.**

There are also many basic examples in the [examples](https://github.com/nats-io/nats.java/tree/main/src/examples/java/io/nats/examples) directory of this repo
and more simple application examples in the [Java Nats Examples](https://github.com/nats-io/java-nats-examples) repo.

### Simplification

Expand All @@ -40,14 +45,6 @@ Check out the [ServiceExample](src/examples/java/io/nats/examples/service/Servic

### Versions Specific Notes

This is version 2.x of the java-nats library.

The API is [simple to use](#listening-for-incoming-messages) and highly [performant](#Benchmarking).

Version 2+ uses a simplified versioning scheme. Any issues will be fixed in the incremental version number. As a major release, the major version has been updated to 2 to allow clients to limit there use of this new API. With the addition of drain() we updated to 2.1, NKey support moved us to 2.2.

Previous versions are still available in the repo.

#### Version 2.17.4 Core Improvements

This release was full of core improvements which improve use of more asynchronous behaviors including
Expand Down

0 comments on commit 20cbd5c

Please sign in to comment.