Skip to content

Commit 5b476a8

Browse files
committed
chore: update README (#95)
1 parent 610d2a7 commit 5b476a8

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@
88

99
The Lithic Java SDK provides convenient access to the Lithic REST API from applications written in Java. It includes helper classes with helpful types and documentation for every request and response property.
1010

11-
This package is currently in beta (pre-v1.0.0). We expect some breaking changes to rarely-used areas of the SDK, and appreciate your [feedback](https://www.github.com/lithic-com/lithic-java/issues).
12-
1311
The Lithic Java SDK is similar to the Lithic Kotlin SDK but with minor differences that make it more ergonomic for use in Java, such as `Optional` instead of nullable values, `Stream` instead of `Sequence`, and `CompletableFuture` instead of suspend functions.
1412

1513
## Documentation
@@ -356,3 +354,14 @@ LithicClient client = LithicOkHttpClient.builder()
356354
.sandbox()
357355
.build();
358356
```
357+
358+
## Semantic Versioning
359+
360+
This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
361+
362+
1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals)_.
363+
2. Changes that we do not expect to impact the vast majority of users in practice.
364+
365+
We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
366+
367+
We are keen for your feedback; please open an [issue](https://www.github.com/lithic-com/lithic-java/issues) with questions, bugs, or suggestions.

0 commit comments

Comments
 (0)