Skip to content

Commit 10acb36

Browse files
authored
Update README with Gradle configuration on how to add library to dependencies (#10)
Resolves #9
1 parent 35bb03e commit 10acb36

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed

README.md

+71
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,77 @@ from [kotlinx.serialization-json](https://github.com/Kotlin/kotlinx.serializatio
88

99
## Usage
1010

11+
### Dependencies
12+
13+
#### Releases
14+
15+
In order to use releases add Maven Central repository to the list of repositories.
16+
17+
##### Kotlin
18+
19+
```kotlin
20+
repositories {
21+
mavenCentral()
22+
}
23+
24+
implementation("io.github.optimumcode:json-schema-validator:0.0.1")
25+
```
26+
27+
##### Groovy
28+
29+
```groovy
30+
repositories {
31+
mavenCentral()
32+
}
33+
34+
implementation 'io.github.optimumcode:json-schema-validator:0.0.1'
35+
```
36+
37+
_Release are published to Sonatype repository. The synchronization with Maven Central takes time._
38+
_If you want to use the release right after the publication you should add Sonatype Release repository to your build script._
39+
40+
##### Kotlin
41+
42+
```kotlin
43+
repositories {
44+
maven(url = "https://s01.oss.sonatype.org/content/repositories/releases/")
45+
}
46+
```
47+
48+
##### Groovy
49+
50+
```groovy
51+
repositories {
52+
maven { url 'https://s01.oss.sonatype.org/content/repositories/releases/' }
53+
}
54+
```
55+
56+
#### Snapshots
57+
58+
_If you want to use SNAPSHOT version you should add Sonatype Snapshot repository to your build script._
59+
60+
##### Kotlin
61+
62+
```kotlin
63+
repositories {
64+
maven(url = "https://s01.oss.sonatype.org/content/repositories/snapshots")
65+
}
66+
67+
implementation("io.github.optimumcode:json-schema-validator:0.0.1-SNAPSHOT")
68+
```
69+
70+
##### Groovy
71+
72+
```groovy
73+
repositories {
74+
maven { url 'https://s01.oss.sonatype.org/content/repositories/snapshots' }
75+
}
76+
77+
implementation 'io.github.optimumcode:json-schema-validator:0.0.1-SNAPSHOT'
78+
```
79+
80+
### Example
81+
1182
```kotlin
1283
import io.github.optimumcode.json.schema.JsonSchema
1384
import io.github.optimumcode.json.schema.ValidationError

0 commit comments

Comments
 (0)