2.3.0 (#316)

Author: mickael-menu

CHANGELOG.md

@@ -4,7 +4,9 @@ All notable changes to this project will be documented in this file. Take a look
 
 **Warning:** Features marked as *experimental* may change or be removed in a future release without notice. Use with caution.
 
-## [Unreleased]
+<!--## [Unreleased]-->
+
+## [2.3.0]
 
 ### Added
 
@@ -636,4 +638,5 @@ progression. Now if no reading progression is set, the `effectiveReadingProgress
 [2.1.1]: https://github.com/readium/kotlin-toolkit/compare/2.1.0...2.1.1
 [2.2.0]: https://github.com/readium/kotlin-toolkit/compare/2.1.1...2.2.0
 [2.2.1]: https://github.com/readium/kotlin-toolkit/compare/2.2.0...2.2.1
+[2.3.0]: https://github.com/readium/kotlin-toolkit/compare/2.2.1...2.3.0
 

README.md

@@ -29,7 +29,7 @@ Readium modules are distributed through [JitPack](https://jitpack.io/#readium/ko
 
 ```groovy
 buildscript {
-    ext.readium_version = '2.2.1'
+    ext.readium_version = '2.3.0'
 }
 
 allprojects {

docs/guides/tts.md

@@ -1,6 +1,6 @@
 # Text-to-speech
 
-:warning: TTS is an experimental feature which is not yet implemented for all formats.
+:warning: The API described in this guide will be changed in the next version of the Kotlin toolkit to support background TTS playback and media notifications. It is recommended that you wait before integrating it in your app.
 
 Text-to-speech can be used to read aloud a publication using a synthetic voice. The Readium toolkit ships with a TTS implementation based on the native [Android TTS engine](https://developer.android.com/reference/android/speech/tts/TextToSpeech), but it is opened for extension if you want to use a different TTS engine.
 

readium/navigator/src/main/java/org/readium/r2/navigator/tts/PublicationSpeechSynthesizer.kt

@@ -34,6 +34,7 @@ import org.readium.r2.shared.util.tokenizer.TextUnit
  */
 @OptIn(DelicateReadiumApi::class)
 @ExperimentalReadiumApi
+@Deprecated("The API described in this guide will be changed in the next version of the Kotlin toolkit to support background TTS playback and media notifications. It is recommended that you wait before integrating it in your app.")
 class PublicationSpeechSynthesizer<E : TtsEngine> private constructor(
     private val publication: Publication,
     config: Configuration,

test-app/build.gradle.kts

@@ -19,7 +19,7 @@ android {
 
         applicationId = "org.readium.r2reader"
 
-        versionName = "2.2.1"
+        versionName = "2.3.0"
 
         testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
         ndk.abiFilters.add("armeabi-v7a")