Skip to content

Commit fbbae40

Browse files
authored
Specify kotlinx lib requirements in README.md (#870)
## Motivation and Context Unfortunately, Kotlin lib requirements are not explicitly stated in README and users encounter errors in runtime in existing projects with Spring, for example, here: #273 and #678 And they might encounter serialization errors while trying the Persistency feature. ## Breaking Changes None --- #### Type of the changes - [ ] New feature (non-breaking change which adds functionality) - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [x] Documentation update - [ ] Tests improvement - [ ] Refactoring #### Checklist - [x] The pull request has a description of the proposed change - [ ] I read the [Contributing Guidelines](https://github.com/JetBrains/koog/blob/main/CONTRIBUTING.md) before opening the pull request - [x] The pull request uses **`develop`** as the base branch - [ ] Tests for the changes have been added - [ ] All new and existing tests passed ##### Additional steps for pull requests adding a new feature - [ ] An issue describing the proposed change exists - [ ] The pull request includes a link to the issue - [ ] The change was discussed and approved in the issue - [ ] Docs have been added / updated
1 parent 1aba521 commit fbbae40

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,17 +76,18 @@ fun main() = runBlocking {
7676

7777
Currently, the framework supports the JVM, JS, WasmJS and iOS targets.
7878

79-
On JVM, JDK 17 or higher is required to use the framework.
79+
### Requirements
8080

81-
Please check the [libs.versions.toml](gradle/libs.versions.toml) to know more about the Koog dependencies.
81+
- JDK 17 or higher is required to use the framework on JVM.
82+
- kotlinx-coroutines 1.10.2 and kotlinx-serialization 1.8.1 versions should be set explicitly in existing projects. Please check the [libs.versions.toml](gradle/libs.versions.toml) to know more about the Koog dependencies.
8283

8384
### Gradle (Kotlin DSL)
8485

8586
1. Add dependencies to the `build.gradle.kts` file:
8687

8788
```
8889
dependencies {
89-
implementation("ai.koog:koog-agents:0.4.1")
90+
implementation("ai.koog:koog-agents:0.4.2")
9091
}
9192
```
9293
2. Make sure that you have `mavenCentral()` in the list of repositories.
@@ -96,7 +97,7 @@ Please check the [libs.versions.toml](gradle/libs.versions.toml) to know more ab
9697
9798
```
9899
dependencies {
99-
implementation 'ai.koog:koog-agents:0.4.1'
100+
implementation 'ai.koog:koog-agents:0.4.2'
100101
}
101102
```
102103
2. Make sure that you have `mavenCentral()` in the list of repositories.
@@ -108,7 +109,7 @@ Please check the [libs.versions.toml](gradle/libs.versions.toml) to know more ab
108109
<dependency>
109110
<groupId>ai.koog</groupId>
110111
<artifactId>koog-agents-jvm</artifactId>
111-
<version>0.4.1</version>
112+
<version>0.4.2</version>
112113
</dependency>
113114
```
114115
2. Make sure that you have `mavenCentral` in the list of repositories.

0 commit comments

Comments
 (0)