Skip to content

Commit 2319be0

Browse files
authored
Update integration/README.md (Kotlin#3485)
Fixes Kotlin#3484
1 parent 550cdf6 commit 2319be0

File tree

1 file changed

+1
-18
lines changed

1 file changed

+1
-18
lines changed

integration/README.md

+1-18
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,11 @@
11
# Coroutines integration
22

33
This directory contains modules that provide integration with various asynchronous callback- and future-based libraries.
4-
Module name below corresponds to the artifact name in Maven/Gradle.
4+
Module names below correspond to the artifact names in Maven/Gradle.
55

66
## Modules
77

88
* [kotlinx-coroutines-jdk8](kotlinx-coroutines-jdk8/README.md) -- integration with JDK8 `CompletableFuture` (Android API level 24).
99
* [kotlinx-coroutines-guava](kotlinx-coroutines-guava/README.md) -- integration with Guava [ListenableFuture](https://github.com/google/guava/wiki/ListenableFutureExplained).
1010
* [kotlinx-coroutines-slf4j](kotlinx-coroutines-slf4j/README.md) -- integration with SLF4J [MDC](https://logback.qos.ch/manual/mdc.html).
1111
* [kotlinx-coroutines-play-services](kotlinx-coroutines-play-services) -- integration with Google Play Services [Tasks API](https://developers.google.com/android/guides/tasks).
12-
13-
## Contributing
14-
15-
Follow the following simple guidelines when contributing integration with your favorite library:
16-
17-
* Keep it simple and general. Ideally it should fit into a single file. If it does not fit, then consider
18-
a separate GitHub project to host this integration.
19-
* Follow the example of other modules.
20-
Cut-and-paste [kotlinx-coroutines-guava](kotlinx-coroutines-guava) module as a template.
21-
* Write tests and documentation, include top-level `README.md` with short overview and example.
22-
* Reference the new module from all the places:
23-
* List of modules in this document.
24-
* List of modules in top-level [`settings.gradle`](../settings.gradle).
25-
* List of modules at the root of documentation site in [`site/docs/index.md`](../site/docs/index.md).
26-
* List of integrations in the root [README.md](../README.md).
27-
* Update links to documentation website as explained [here](../knit/README.md#usage).
28-
* Squash your contribution to a single commit and create pull request to `develop` branch.

0 commit comments

Comments
 (0)