Skip to content

Commit dd18f1d

Browse files
authored
Merge pull request #6 from PortalTechnologiesInc/docs/versioning-and-0.3.0
docs: update version to 0.3.0, add versioning & compatibility section
2 parents 7583555 + 24fdbcf commit dd18f1d

1 file changed

Lines changed: 19 additions & 3 deletions

File tree

README.MD

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ A Java client for the Portal WebSocket Server, providing Nostr-based authenticat
2626
2. Add the dependency to your `build.gradle`:
2727
```groovy
2828
dependencies {
29-
implementation 'com.github.PortalTechnologiesInc:java-sdk:0.2.1'
29+
implementation 'com.github.PortalTechnologiesInc:java-sdk:0.3.0'
3030
}
3131
```
3232

@@ -35,11 +35,27 @@ A Java client for the Portal WebSocket Server, providing Nostr-based authenticat
3535
<dependency>
3636
<groupId>com.github.PortalTechnologiesInc</groupId>
3737
<artifactId>java-sdk</artifactId>
38-
<version>0.2.1</version>
38+
<version>0.3.0</version>
3939
</dependency>
4040
```
4141

42-
3. Once you’re done, you may now proceed integrating the SDK into your project.
42+
3. Once you're done, you may now proceed integrating the SDK into your project.
43+
44+
---
45+
46+
## Versioning & Compatibility
47+
48+
The Java SDK version is kept in sync with the [Portal SDK Daemon](https://hub.docker.com/r/getportal/sdk-daemon) (`getportal/sdk-daemon`).
49+
50+
**Compatibility rule:** the `major.minor` version of the SDK must match the `major.minor` version of the SDK Daemon. The patch version (`x` in `0.3.x`) is independent and can differ — it only contains bug fixes.
51+
52+
| SDK version | SDK Daemon version |
53+
|-------------|-------------------|
54+
| `0.3.x` | `0.3.x` |
55+
56+
**Example:** SDK `0.3.0` works with `getportal/sdk-daemon:0.3.1`, but not with `getportal/sdk-daemon:0.4.0`.
57+
58+
When upgrading to a new `major.minor`, update both the SDK dependency and the Docker image tag together.
4359

4460

4561
---

0 commit comments

Comments
 (0)