Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
zigzago committed Mar 21, 2021
1 parent 3d490b1 commit e0c8afd
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 19 deletions.
4 changes: 2 additions & 2 deletions kmongo-kdoc/docs/extensions-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ col.distinct(Friend::address)
### projection

You can use [```MongoCollection.projection```](https://litote.org/kmongo/dokka/kmongo/org.litote.kmongo/com.mongodb.client.-mongo-collection/projection.html)
extension functions in order to retrieve only one, two or three fields. This is a "kmongo sync driver only feature" for now:
extension functions in order to retrieve only one, two or three fields:

```kotlin
col.bulkWrite(
Expand All @@ -262,7 +262,7 @@ col.bulkWrite(
val result: List<String?> = col.projection(Friend::name).toList()
```

If you need to retrieve more than three fields - or if you don't use the sync driver - you have two options:
If you need to retrieve more than three fields - you have two options:

- Use a custom dedicated class with [```FindIterable.projection```](https://litote.org/kmongo/dokka/kmongo/org.litote.kmongo/com.mongodb.client.-find-iterable/projection.html) functions.

Expand Down
4 changes: 2 additions & 2 deletions kmongo-kdoc/docs/object-mapping.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,14 @@ You just have to add the ```kmongo-id``` dependency in the frontend to compile.
<dependency>
<groupId>org.litote.kmongo</groupId>
<artifactId>kmongo-id</artifactId>
<version>4.2.4</version>
<version>4.2.5</version>
</dependency>
```

- or Gradle

```
compile 'org.litote.kmongo:kmongo-id:4.2.4'
compile 'org.litote.kmongo:kmongo-id:4.2.5'
```

#### Id <> Json Jackson serialization
Expand Down
30 changes: 15 additions & 15 deletions kmongo-kdoc/docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@ If you don't know, start with the sync driver and add this dependency to your pr
<dependency>
<groupId>org.litote.kmongo</groupId>
<artifactId>kmongo</artifactId>
<version>4.2.4</version>
<version>4.2.5</version>
</dependency>
```

- or Gradle

*(Kotlin)*
```kotlin
implementation("org.litote.kmongo:kmongo:4.2.4")
implementation("org.litote.kmongo:kmongo:4.2.5")
```
*(Groovy)*
```groovy
implementation 'org.litote.kmongo:kmongo:4.2.4'
implementation 'org.litote.kmongo:kmongo:4.2.5'
```

> Starting from 4.0, minimum supported jvm is now 1.8 (was 1.6).
Expand All @@ -45,19 +45,19 @@ For the asynchronous driver, reactive streams style, [Kotlin Coroutines](https:/
<dependency>
<groupId>org.litote.kmongo</groupId>
<artifactId>kmongo-async</artifactId>
<version>4.2.4</version>
<version>4.2.5</version>
</dependency>
```

- or Gradle

*(Kotlin)*
```kotlin
implementation("org.litote.kmongo:kmongo-async:4.2.4")
implementation("org.litote.kmongo:kmongo-async:4.2.5")
```
*(Groovy)*
```groovy
implementation 'org.litote.kmongo:kmongo-async:4.2.4'
implementation 'org.litote.kmongo:kmongo-async:4.2.5'
```

#### Kotlin Coroutines
Expand All @@ -68,19 +68,19 @@ implementation 'org.litote.kmongo:kmongo-async:4.2.4'
<dependency>
<groupId>org.litote.kmongo</groupId>
<artifactId>kmongo-coroutine</artifactId>
<version>4.2.4</version>
<version>4.2.5</version>
</dependency>
```

- or Gradle (Kotlin)

*(Kotlin)*
```kotlin
implementation("org.litote.kmongo:kmongo-coroutine:4.2.4")
implementation("org.litote.kmongo:kmongo-coroutine:4.2.5")
```
*(Groovy)*
```groovy
implementation 'org.litote.kmongo:kmongo-coroutine:4.2.4'
implementation 'org.litote.kmongo:kmongo-coroutine:4.2.5'
```

#### Reactor
Expand All @@ -89,19 +89,19 @@ implementation 'org.litote.kmongo:kmongo-coroutine:4.2.4'
<dependency>
<groupId>org.litote.kmongo</groupId>
<artifactId>kmongo-reactor</artifactId>
<version>4.2.4</version>
<version>4.2.5</version>
</dependency>
```

- or Gradle

*(Kotlin)*
```kotlin
implementation("org.litote.kmongo:kmongo-reactor:4.2.4")
implementation("org.litote.kmongo:kmongo-reactor:4.2.5")
```
*(Groovy)*
```groovy
implementation 'org.litote.kmongo:kmongo-reactor:4.2.4'
implementation 'org.litote.kmongo:kmongo-reactor:4.2.5'
```

#### RxJava2
Expand All @@ -112,19 +112,19 @@ implementation 'org.litote.kmongo:kmongo-reactor:4.2.4'
<dependency>
<groupId>org.litote.kmongo</groupId>
<artifactId>kmongo-rxjava2</artifactId>
<version>4.2.4</version>
<version>4.2.5</version>
</dependency>
```

- or Gradle

*(Kotlin)*
```kotlin
implementation("org.litote.kmongo:kmongo-rxjava2:4.2.4")
implementation("org.litote.kmongo:kmongo-rxjava2:4.2.5")
```
*(Groovy)*
```groovy
implementation 'org.litote.kmongo:kmongo-rxjava2:4.2.4'
implementation 'org.litote.kmongo:kmongo-rxjava2:4.2.5'
```

## Object Mapping Engine
Expand Down

0 comments on commit e0c8afd

Please sign in to comment.