Skip to content

Commit c2b3d60

Browse files
committed
Update README
1 parent 25dca4c commit c2b3d60

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44

55
A library for interacting with blocking JDBC drivers using [Kotlin Coroutines][coroutines].
66

7+
Use of this library allows you to offload blocking JDBC calls to a dedicated
8+
[`CoroutineDispatcher`][CoroutineDispatcher] (e.g.
9+
[`Dispatchers.IO`][Dispatchers.IO]), thus suspending your coroutine and freeing
10+
your thread for other work while waiting.
11+
712
## Installation
813

914
```groovy
@@ -128,6 +133,8 @@ This project is available under the terms of the ISC license. See the
128133

129134
[coroutines]: https://kotlinlang.org/docs/reference/coroutines-overview.html
130135
[CoroutineContext]: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/
136+
[CoroutineDispatcher]: https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/-coroutine-dispatcher/index.html
137+
[Dispatchers.IO]: https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/-dispatchers/-i-o.html
131138

132139
[Connection]: https://docs.oracle.com/javase/8/docs/api/java/sql/Connection.html
133140
[Connection.close]: https://docs.oracle.com/javase/8/docs/api/java/sql/Connection.html#close--

0 commit comments

Comments
 (0)