This directory contains modules that provide integration with various asynchronous callback- and future-based libraries. Module names below correspond to the artifact names in Maven/Gradle.
- kotlinx-coroutines-jdk8 -- integration with JDK8
CompletableFuture
(Android API level 24). - kotlinx-coroutines-guava -- integration with Guava ListenableFuture.
- kotlinx-coroutines-slf4j -- integration with SLF4J MDC.
- kotlinx-coroutines-play-services -- integration with Google Play Services Tasks API.
Follow the following simple guidelines when contributing an integration with your favorite library:
- Keep it simple and general. Ideally, it should fit into a single file. If it does not fit, consider a separate GitHub project for hosting this integration.
- Follow the example of other modules. Copy-and-paste kotlinx-coroutines-guava module as a template.
- Write tests and documentation, include a top-level
README.md
with a short overview and an example. - Reference the new module from all the places:
- List of modules in this document.
- List of modules in the top-level
settings.gradle
. - List of integrations in the root README.md.
- Create a pull request to the
develop
branch.