Skip to content

Commit c40c781

Browse files
committed
Top level readme improved
1 parent f76606a commit c40c781

File tree

1 file changed

+13
-21
lines changed

1 file changed

+13
-21
lines changed

README.md

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,19 @@ Library support for Kotlin coroutines. This is a companion version for Kotlin 1.
44

55
## Modules
66

7-
Core module:
8-
9-
* [kotlinx-coroutines-core](kotlinx-coroutines-core) -- core primitives to work with coroutines.
10-
11-
Modules that provide builders and iteration support for various reactive streams libraries:
12-
13-
* [kotlinx-coroutines-reactive](reactive/kotlinx-coroutines-reactive) -- utilities for [Reactive Streams](http://www.reactive-streams.org)
14-
* [kotlinx-coroutines-reactor](reactive/kotlinx-coroutines-reactor) -- utilities for [Reactor](https://projectreactor.io)
15-
* [kotlinx-coroutines-rx1](reactive/kotlinx-coroutines-rx1) -- utilities for [RxJava 1.x](https://github.com/ReactiveX/RxJava/tree/1.x)
16-
* [kotlinx-coroutines-rx2](reactive/kotlinx-coroutines-rx2) -- utilities for [RxJava 2.x](https://github.com/ReactiveX/RxJava)
17-
18-
Modules that provide coroutine dispatchers for various single-threaded UI libraries:
19-
20-
* [kotlinx-coroutines-android](ui/kotlinx-coroutines-android) -- `UI` context for Android applications.
21-
* [kotlinx-coroutines-javafx](ui/kotlinx-coroutines-javafx) -- `JavaFx` context for JavaFX UI applications.
22-
* [kotlinx-coroutines-swing](ui/kotlinx-coroutines-swing) -- `Swing` context for Swing UI applications.
23-
24-
Modules that provide integration with various asynchronous callback- and future-based libraries:
25-
26-
* [kotlinx-coroutines-jdk8](integration/kotlinx-coroutines-jdk8) -- extensions for JDK8 `CompletableFuture` (Android API level 24).
27-
* [kotlinx-coroutines-nio](integration/kotlinx-coroutines-nio) -- extensions for asynchronous IO on JDK7+ (Android O Preview).
7+
* [kotlinx-coroutines-core](kotlinx-coroutines-core/README.md) -- core primitives to work with coroutines:
8+
* `launch`, `async`, `produce`, `actor`, etc coroutine builders;
9+
* `Job` and `Deferred` light-weight future with cancellation support;
10+
* `CommonPool` and other coroutine contexts;
11+
* `Channel` and `Mutex` communication and synchronization primitives;
12+
* `delay`, `yield`, etc top-level suspending functions;
13+
* `select` expression support and more.
14+
* [reactive](reactive/README.md) -- modules that provide builders and iteration support for various reactive streams libraries:
15+
* Reactive Streams, RxJava 1.x and 2.x and Project Reactor.
16+
* [ui](ui/README.md) -- modules that provide coroutine dispatchers for various single-threaded UI libraries:
17+
* Android, JavaFx, and Swing.
18+
* [integration](integration/README.md) -- modules that provide integration with various asynchronous callback- and future-based libraries.
19+
* `CompletableFuture` and synchronous networking/IO.
2820

2921
## Documentation
3022

0 commit comments

Comments
 (0)