Skip to content

Commit

Permalink
Merge pull request #128 from dybarsky/pr/maven
Browse files Browse the repository at this point in the history
Add maven dependencies declaration docs
  • Loading branch information
jillesvangurp authored Mar 22, 2024
2 parents 78bc5c2 + d24946b commit 479c140
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
38 changes: 38 additions & 0 deletions docs/src/test/kotlin/documentation/projectreadme/maven.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## Maven

If you have maven based kotlin project targeting jvm and can't use kotlin multiplatform dependency, you would need to add jvm targeting artifacts.

Add the `maven.tryformation.com` repository:

```xml
<repositories>
<repository>
<id>try-formation</id>
<name>kt search repository</name>
<url>https://maven.tryformation.com/releases</url>
</repository>
</repositories>
```

And then add dependencies to jvm targets:

```xml
<dependencies>
<dependency>
<groupId>com.jillesvangurp</groupId>
<artifactId>search-client-jvm</artifactId>
<version>2.1.25</version>
</dependency>
<dependency>
<groupId>com.jillesvangurp</groupId>
<artifactId>search-dsls-jvm</artifactId>
<version>2.1.25</version>
</dependency>
<dependency>
<groupId>com.jillesvangurp</groupId>
<artifactId>json-dsl-jvm</artifactId>
<version>3.0.0</version>
</dependency>
</dependencies>
```
**Note:** The `json-dsl` is moved to separate repository. To find the latest version number, check releases: https://github.com/jillesvangurp/json-dsl/releases
2 changes: 2 additions & 0 deletions docs/src/test/kotlin/documentation/projectreadme/readme.kt
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ val projectReadme = sourceGitRepository.md {

includeMdFile("gradle.md")

includeMdFile("maven.md")

section("Usage") {
// our test server runs on port 9999
val client = SearchClient(
Expand Down

0 comments on commit 479c140

Please sign in to comment.