Skip to content

Commit 9ca0391

Browse files
committed
add an intro to the migration guide
1 parent 884ec63 commit 9ca0391

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Install the Kotlin client by adding the following dependency to your `gradle.bui
5959
For full documentation, visit the **[Algolia Kotlin API Client](https://www.algolia.com/doc/api-client/getting-started/install/kotlin/)**.
6060

6161
⚠️ Important: starting from version `1.4.0` the library is compatible only with kotlin version `1.3.70` or higher; for previous versions of kotlin, please use version `1.3.1` of the library.
62-
ℹ️ If you migrate from `1.4.0` to `1.5.0` please follow the [migration guide](guide/Migrate_1.4.x_1.5.x.md).
62+
ℹ️ Please follow the [migration guide](docs/guide/Migrate_1.4.x_1.5.x.md) to migrate from `1.4.x` or below to the latest version.
6363

6464
### Coroutines
6565

guide/Migrate_1.4.x_1.5.x.md renamed to docs/guide/Migrate_1.4.x_1.5.x.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# Migrate from 1.4.x to 1.5.x
22

3-
## Gradle
3+
Version `1.5.x` of the library uses the latest Kotlin version `1.4.0` and Kotlin serialization `1.0.0`. If you want to migrate from
4+
`1.4.x` to `1.5.x` please follow these steps:
5+
6+
### Gradle
47
The library now uses the full power of [Gradle metadata module](https://blog.gradle.org/gradle-metadata-1.0).
58

69
In the case you are using the android variant of the library
@@ -15,7 +18,7 @@ implementation "com.algolia:algoliasearch-client-kotlin:$kotlin_client_version"
1518
```
1619
Otherwise, nothing has to be changed.
1720

18-
## Serialization
21+
### Serialization
1922
A significant part of the public API was renamed or extracted to a separate package.
2023
Here is the most important parts from the kotlinx serialization's [migration guide](https://github.com/Kotlin/kotlinx.serialization/blob/1.0.0-RC/docs/migration.md):
2124

0 commit comments

Comments
 (0)