diff --git a/README.md b/README.md index 4a41766..f4c6820 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,94 @@ This library is a JSON Parser built specifically for JNATS to avoid a 3rd party library dependency. -It has been extracted and repackaged from the JNATS library since it is also used by the [jwt.java](https://github.com/nats-io/jwt.java) library. +It has been extracted and repackaged from the JNATS library as part of the effort to upgrade and repackage the JNATS client. -**Current Release**: 2.0.1   **Current Snapshot**: 2.0.2-SNAPSHOT +**Current Release**: 3.0.0   **Current Snapshot**: 0.0.0-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-json/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.nats/jnats-json) -[![Javadoc](http://javadoc.io/badge/io.nats/jnats-json.svg?branch=main)](http://javadoc.io/doc/io.nats/jnats-json?branch=main) -[![Coverage Status](https://coveralls.io/repos/github/nats-io/json.java/badge.svg?branch=main)](https://coveralls.io/github/nats-io/json.java?branch=main) -[![Build Main Badge](https://github.com/nats-io/json.java/actions/workflows/build-main.yml/badge.svg?event=push)](https://github.com/nats-io/json.java/actions/workflows/build-main.yml) -[![Release Badge](https://github.com/nats-io/json.java/actions/workflows/build-release.yml/badge.svg?event=release)](https://github.com/nats-io/json.java/actions/workflows/build-release.yml) +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.synadia/jnats-json/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.synadia/jnats-json) +[![Javadoc](http://javadoc.io/badge/io.synadia/jnats-json.svg?branch=main)](http://javadoc.io/doc/io.synadia/jnats-json?branch=main) +[![Coverage Status](https://coveralls.io/repos/github/synadia-io/json.java/badge.svg?branch=main)](https://coveralls.io/github/synadia-io/json.java?branch=main) +[![Build Main Badge](https://github.com/synadia-io/json.java/actions/workflows/build-main.yml/badge.svg?event=push)](https://github.com/synadia-io/json.java/actions/workflows/build-main.yml) +[![Release Badge](https://github.com/synadia-io/json.java/actions/workflows/build-release.yml/badge.svg?event=release)](https://github.com/synadia-io/json.java/actions/workflows/build-release.yml) + +### Gradle + +```groovy +dependencies { + implementation 'io.synadia:jnats-json:{major.minor.patch}' +} +``` + +If you need the latest and greatest before Maven central updates, you can use: + +```groovy +repositories { + mavenCentral() + maven { + url "https://repo1.maven.org/maven2/" + } +} +``` + +If you need a snapshot version, you must add the url for the snapshots and change your dependency. + +```groovy +repositories { + mavenCentral() + maven { + url "https://central.sonatype.com/repository/maven-snapshots/" + } +} + +dependencies { + implementation 'io.synadia:jnats-json:{major.minor.patch}-SNAPSHOT' +} +``` + +### Maven + +```xml + + io.synadia + jnats-json + {major.minor.patch} + +``` + +If you need the absolute latest, before it propagates to maven central, you can use the repository: + +```xml + + + sonatype releases + https://repo1.maven.org/maven2 + + true + + + +``` + +If you need a snapshot version, you must enable snapshots and change your dependency. + +```xml + + + sonatype snapshots + https://central.sonatype.com/repository/maven-snapshots/ + + true + + + + + + io.synadia + jnats-json + {major.minor.patch}-SNAPSHOT + +``` ## License diff --git a/build.gradle b/build.gradle index 6530529..1d9da59 100644 --- a/build.gradle +++ b/build.gradle @@ -122,7 +122,7 @@ publishing { groupId = group artifactId = archivesBaseName description = 'JSON Parser built specifically for JNATS' - url = 'https://github.com/nats-io/nats.java.json' + url = 'https://github.com/synadia-io/json.java' licenses { license { name = 'The Apache License, Version 2.0' @@ -134,11 +134,11 @@ publishing { id = "synadia" name = "Synadia" email = "info@synadia.com" - url = "https://nats.io" + url = "https://synadia.io" } } scm { - url = 'https://github.com/nats-io/nats.java.json' + url = 'https://github.com/synadia-io/json.java' } } } diff --git a/dependencies.md b/dependencies.md index ec2c8bd..eebb70c 100644 --- a/dependencies.md +++ b/dependencies.md @@ -4,21 +4,11 @@ This file lists the dependencies used in this repository. #### Runtime Dependencies -None +TODO #### Test Dependencies -| Dependency | License | -|-------------------------------------------------|-----------------------------------------| -| org.apiguardian:apiguardian-api:1.1.0 | Apache 2.0 License | -| org.junit.jupiter:junit-jupiter-api:5.7.0 | Apache 2.0 License | -| org.junit.jupiter:junit-jupiter-engine:5.7.0 | Apache 2.0 License | -| org.junit.jupiter:junit-jupiter-params:5.7.0 | Apache 2.0 License | -| org.junit.jupiter:junit-jupiter:5.7.0 | Apache 2.0 License | -| org.junit.platform:junit-platform-commons:1.7.0 | Apache 2.0 License | -| org.junit.platform:junit-platform-engine:1.7.0 | Apache 2.0 License | -| org.junit:junit-bom:5.7.0 | Apache 2.0 License | -| org.opentest4j:opentest4j:1.2.0 | Apache 2.0 License | +TODO #### Build / Coverage Dependencies