Skip to content

Commit 02b1c04

Browse files
committed
Update readme file to add information how to add dependency in maven project
1 parent 5ae9fc4 commit 02b1c04

File tree

1 file changed

+53
-6
lines changed

1 file changed

+53
-6
lines changed

README.md

Lines changed: 53 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,9 @@ from [kotlinx.serialization-json](https://github.com/Kotlin/kotlinx.serializatio
4040

4141
In order to use releases add Maven Central repository to the list of repositories.
4242

43-
##### Kotlin
43+
##### Gradle
44+
45+
###### Kotlin
4446

4547
```kotlin
4648
repositories {
@@ -50,7 +52,7 @@ repositories {
5052
implementation("io.github.optimumcode:json-schema-validator:0.5.1")
5153
```
5254

53-
##### Groovy
55+
###### Groovy
5456

5557
```groovy
5658
repositories {
@@ -68,27 +70,42 @@ implementation("io.github.optimumcode:json-schema-validator")
6870
_Release are published to Sonatype repository. The synchronization with Maven Central takes time._
6971
_If you want to use the release right after the publication you should add Sonatype Release repository to your build script._
7072

71-
##### Kotlin
73+
###### Kotlin
7274

7375
```kotlin
7476
repositories {
7577
maven(url = "https://s01.oss.sonatype.org/content/repositories/releases/")
7678
}
7779
```
7880

79-
##### Groovy
81+
###### Groovy
8082

8183
```groovy
8284
repositories {
8385
maven { url 'https://s01.oss.sonatype.org/content/repositories/releases/' }
8486
}
8587
```
8688

89+
##### Maven
90+
91+
You can also use `json-schema-validator` as a dependency in your maven project.
92+
But Maven cannot use Gradle's metadata so you need to depend on a JVM-specific artifact in your project:
93+
94+
```xml
95+
<dependency>
96+
<groupId>io.github.optimumcode</groupId>
97+
<artifactId>json-schema-validator-jvm</artifactId>
98+
<version>0.5.1</version>
99+
</dependency>
100+
```
101+
87102
#### Snapshots
88103

89104
_If you want to use SNAPSHOT version you should add Sonatype Snapshot repository to your build script._
90105

91-
##### Kotlin
106+
##### Gradle
107+
108+
###### Kotlin
92109

93110
```kotlin
94111
repositories {
@@ -103,7 +120,7 @@ implementation(platform("io.github.optimumcode:json-schema-validator-bom:0.5.2-S
103120
implementation("io.github.optimumcode:json-schema-validator")
104121
```
105122

106-
##### Groovy
123+
###### Groovy
107124

108125
```groovy
109126
repositories {
@@ -113,6 +130,36 @@ repositories {
113130
implementation 'io.github.optimumcode:json-schema-validator:0.5.2-SNAPSHOT'
114131
```
115132

133+
##### Maven
134+
135+
For the Maven you need to add a snapshot repository to your POM file
136+
137+
```xml
138+
<repositories>
139+
<repository>
140+
<id>sonatype</id>
141+
<name>sonatype-snapshot</name>
142+
<url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>
143+
<snapshots>
144+
<enabled>true</enabled>
145+
</snapshots>
146+
<releases>
147+
<enabled>false</enabled>
148+
</releases>
149+
</repository>
150+
</repositories>
151+
```
152+
153+
And then you can add a dependency to a SNAPSHOT version
154+
155+
```xml
156+
<dependency>
157+
<groupId>io.github.optimumcode</groupId>
158+
<artifactId>json-schema-validator-jvm</artifactId>
159+
<version>0.5.2-SNAPSHOT</version>
160+
</dependency>
161+
```
162+
116163
### Example
117164

118165
If you have just one JSON schema or many independent schemes

0 commit comments

Comments
 (0)