Skip to content

Update integration/README.md #3485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 19, 2022
Merged

Update integration/README.md #3485

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ddfd727
Update integration/README.md
dkhalanskyjb Oct 17, 2022
8b59d17
Remove the instructions for contributing new integrations
dkhalanskyjb Oct 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 1 addition & 18 deletions integration/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,11 @@
# Coroutines integration

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

## Modules

* [kotlinx-coroutines-jdk8](kotlinx-coroutines-jdk8/README.md) -- integration with JDK8 `CompletableFuture` (Android API level 24).
* [kotlinx-coroutines-guava](kotlinx-coroutines-guava/README.md) -- integration with Guava [ListenableFuture](https://github.com/google/guava/wiki/ListenableFutureExplained).
* [kotlinx-coroutines-slf4j](kotlinx-coroutines-slf4j/README.md) -- integration with SLF4J [MDC](https://logback.qos.ch/manual/mdc.html).
* [kotlinx-coroutines-play-services](kotlinx-coroutines-play-services) -- integration with Google Play Services [Tasks API](https://developers.google.com/android/guides/tasks).

## Contributing

Follow the following simple guidelines when contributing integration with your favorite library:

* Keep it simple and general. Ideally it should fit into a single file. If it does not fit, then consider
a separate GitHub project to host this integration.
* Follow the example of other modules.
Cut-and-paste [kotlinx-coroutines-guava](kotlinx-coroutines-guava) module as a template.
* Write tests and documentation, include top-level `README.md` with short overview and example.
* Reference the new module from all the places:
* List of modules in this document.
* List of modules in top-level [`settings.gradle`](../settings.gradle).
* List of modules at the root of documentation site in [`site/docs/index.md`](../site/docs/index.md).
* List of integrations in the root [README.md](../README.md).
* Update links to documentation website as explained [here](../knit/README.md#usage).
* Squash your contribution to a single commit and create pull request to `develop` branch.