diff --git a/compat/compat-kotlinx-datetime/README.md b/compat/compat-kotlinx-datetime/README.md index 2ad8d57..ce3fa2f 100644 --- a/compat/compat-kotlinx-datetime/README.md +++ b/compat/compat-kotlinx-datetime/README.md @@ -1,4 +1,4 @@ -# Module Compatibility with KotlinX.Datetime +# Module Compatibility with KotlinX.Datetime (DEPRECATED) Control the virtual time during tests using KotlinX.Datetime. @@ -7,6 +7,16 @@ Control the virtual time during tests using KotlinX.Datetime. Builds upon the [virtual time control][opensavvy.prepared.suite.time] available out-of-the-box to allow [instancing clocks][opensavvy.prepared.compat.kotlinx.datetime.clock], [setting the current time][opensavvy.prepared.compat.kotlinx.datetime.set] or [waiting for a given time][opensavvy.prepared.compat.kotlinx.datetime.delayUntil]. +## Deprecation notice + +This module is built on top of the KotlinX.Datetime support for `Instant` and `Clock`, which have been removed in KotlinX.Datetime 0.7.0. + +`Instant` and `Clock` have been moved to the Kotlin standard library. The contents of this compatibility module have therefore been integrated into the main Prepared module, Prepared Suite. + +All functionality provided by this module is available in Prepared Suite, with a different package name. + +This module will not be updated in the future. + ## Example We want to test a fictional `Scheduler` implemented using [KotlinX.Coroutines](https://kotlinlang.org/docs/coroutines-guide.html). diff --git a/compat/compat-kotlinx-datetime/build.gradle.kts b/compat/compat-kotlinx-datetime/build.gradle.kts index fa816ec..b99ebd8 100644 --- a/compat/compat-kotlinx-datetime/build.gradle.kts +++ b/compat/compat-kotlinx-datetime/build.gradle.kts @@ -51,7 +51,7 @@ kotlin { } library { - name.set("Compatibility with KotlinX.Datetime") + name.set("Compatibility with KotlinX.Datetime (DEPRECATED)") description.set("Control the passing of time in Prepared tests using objects and methods from KotlinX.Datetime, including Clock and Instant") homeUrl.set("https://opensavvy.gitlab.io/groundwork/prepared/api-docs/compat/compat-kotlinx-datetime/index.html")