Skip to content

Commit 90e40d9

Browse files
authored
Merge pull request #1 from synadia-io/start
Start 3.0.0
2 parents 094a74c + 43e818c commit 90e40d9

File tree

3 files changed

+90
-22
lines changed

3 files changed

+90
-22
lines changed

README.md

Lines changed: 85 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,94 @@
44

55
This library is a JSON Parser built specifically for JNATS to avoid a 3rd party library dependency.
66

7-
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.
7+
It has been extracted and repackaged from the JNATS library as part of the effort to upgrade and repackage the JNATS client.
88

9-
**Current Release**: 2.0.1   **Current Snapshot**: 2.0.2-SNAPSHOT
9+
**Current Release**: 3.0.0   **Current Snapshot**: 0.0.0-SNAPSHOT
1010

1111
[![License Apache 2](https://img.shields.io/badge/License-Apache2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
12-
[![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)
13-
[![Javadoc](http://javadoc.io/badge/io.nats/jnats-json.svg?branch=main)](http://javadoc.io/doc/io.nats/jnats-json?branch=main)
14-
[![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)
15-
[![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)
16-
[![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)
12+
[![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)
13+
[![Javadoc](http://javadoc.io/badge/io.synadia/jnats-json.svg?branch=main)](http://javadoc.io/doc/io.synadia/jnats-json?branch=main)
14+
[![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)
15+
[![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)
16+
[![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)
17+
18+
### Gradle
19+
20+
```groovy
21+
dependencies {
22+
implementation 'io.synadia:jnats-json:{major.minor.patch}'
23+
}
24+
```
25+
26+
If you need the latest and greatest before Maven central updates, you can use:
27+
28+
```groovy
29+
repositories {
30+
mavenCentral()
31+
maven {
32+
url "https://repo1.maven.org/maven2/"
33+
}
34+
}
35+
```
36+
37+
If you need a snapshot version, you must add the url for the snapshots and change your dependency.
38+
39+
```groovy
40+
repositories {
41+
mavenCentral()
42+
maven {
43+
url "https://central.sonatype.com/repository/maven-snapshots/"
44+
}
45+
}
46+
47+
dependencies {
48+
implementation 'io.synadia:jnats-json:{major.minor.patch}-SNAPSHOT'
49+
}
50+
```
51+
52+
### Maven
53+
54+
```xml
55+
<dependency>
56+
<groupId>io.synadia</groupId>
57+
<artifactId>jnats-json</artifactId>
58+
<version>{major.minor.patch}</version>
59+
</dependency>
60+
```
61+
62+
If you need the absolute latest, before it propagates to maven central, you can use the repository:
63+
64+
```xml
65+
<repositories>
66+
<repository>
67+
<id>sonatype releases</id>
68+
<url>https://repo1.maven.org/maven2</url>
69+
<releases>
70+
<enabled>true</enabled>
71+
</releases>
72+
</repository>
73+
</repositories>
74+
```
75+
76+
If you need a snapshot version, you must enable snapshots and change your dependency.
77+
78+
```xml
79+
<repositories>
80+
<repository>
81+
<id>sonatype snapshots</id>
82+
<url>https://central.sonatype.com/repository/maven-snapshots/</url>
83+
<snapshots>
84+
<enabled>true</enabled>
85+
</snapshots>
86+
</repository>
87+
</repositories>
88+
89+
<dependency>
90+
<groupId>io.synadia</groupId>
91+
<artifactId>jnats-json</artifactId>
92+
<version>{major.minor.patch}-SNAPSHOT</version>
93+
</dependency>
94+
```
1795

1896

1997
## License

build.gradle

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ publishing {
122122
groupId = group
123123
artifactId = archivesBaseName
124124
description = 'JSON Parser built specifically for JNATS'
125-
url = 'https://github.com/nats-io/nats.java.json'
125+
url = 'https://github.com/synadia-io/json.java'
126126
licenses {
127127
license {
128128
name = 'The Apache License, Version 2.0'
@@ -134,11 +134,11 @@ publishing {
134134
id = "synadia"
135135
name = "Synadia"
136136
email = "info@synadia.com"
137-
url = "https://nats.io"
137+
url = "https://synadia.io"
138138
}
139139
}
140140
scm {
141-
url = 'https://github.com/nats-io/nats.java.json'
141+
url = 'https://github.com/synadia-io/json.java'
142142
}
143143
}
144144
}

dependencies.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,11 @@ This file lists the dependencies used in this repository.
44

55
#### Runtime Dependencies
66

7-
None
7+
TODO
88

99
#### Test Dependencies
1010

11-
| Dependency | License |
12-
|-------------------------------------------------|-----------------------------------------|
13-
| org.apiguardian:apiguardian-api:1.1.0 | Apache 2.0 License |
14-
| org.junit.jupiter:junit-jupiter-api:5.7.0 | Apache 2.0 License |
15-
| org.junit.jupiter:junit-jupiter-engine:5.7.0 | Apache 2.0 License |
16-
| org.junit.jupiter:junit-jupiter-params:5.7.0 | Apache 2.0 License |
17-
| org.junit.jupiter:junit-jupiter:5.7.0 | Apache 2.0 License |
18-
| org.junit.platform:junit-platform-commons:1.7.0 | Apache 2.0 License |
19-
| org.junit.platform:junit-platform-engine:1.7.0 | Apache 2.0 License |
20-
| org.junit:junit-bom:5.7.0 | Apache 2.0 License |
21-
| org.opentest4j:opentest4j:1.2.0 | Apache 2.0 License |
11+
TODO
2212

2313
#### Build / Coverage Dependencies
2414

0 commit comments

Comments
 (0)