Skip to content

Commit

Permalink
Explain the existence of both stable and in-development versions of t…
Browse files Browse the repository at this point in the history
…his library.
  • Loading branch information
armiol committed Dec 22, 2023
1 parent a9e49cc commit cf3b603
Showing 1 changed file with 28 additions and 6 deletions.
34 changes: 28 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,41 @@ See [gcloud-java](https://github.com/SpineEventEngine/gcloud-java/) for Google C

### Artifacts

Gradle:
This library is intended to be used together with other Spine Event Engine libraries,
as a Storage port connecting the application to RDBMS system of choice.

For the details on setting up the server environment please refer to
[Spine Bootstrap Gradle plugin](https://github.com/SpineEventEngine/bootstrap/) and
[Spine `core` modules](https://github.com/SpineEventEngine/core-java/) documentation.

#### Stable version

Stable version requires Java 8+.

Use the following dependency in your Gradle build scripts:

```kotlin
dependencies {
implementation("io.spine:spine-rdbms:1.9.0")
}
```

This artifact should be used as a part of the Spine server application.

For the details on setting up the server environment please refer to
[Spine Bootstrap Gradle plugin](https://github.com/SpineEventEngine/bootstrap/) and
[Spine `core` modules](https://github.com/SpineEventEngine/core-java/) documentation.
#### 2.x

Version 2.x is still in development, but as of now, it fully supports all major features
brought by Spine 2.x family.

It requires Java 11+.

Use the following dependency in your Gradle build scripts:

```kotlin
dependencies {
implementation("io.spine:spine-rdbms:2.0.0-SNAPSHOT.92")
}
```

:warning: The exact snapshot version for version 2.x is listed in `version.gradle.kts`.

### Configuration

Expand Down

0 comments on commit cf3b603

Please sign in to comment.