Skip to content

Commit 2a63892

Browse files
committed
Small "Introduction and setup" section added
1 parent 43604bd commit 2a63892

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

coroutines-guide.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,17 @@ class GuideTest {
3434

3535
This is a short guide on core features of `kotlinx.coroutines` with a series of examples.
3636

37+
## Introduction and setup
38+
39+
Kotlin, as a language, provides only minimal low-level APIs in its standard library to enable various other
40+
libraries to utilize coroutines. Unlike many other languages with similar capabilities, `async` and `await`
41+
are not keywords in Kotlin and are not even part of its standard library.
42+
43+
`kotlinx.coroutines` in one such rich library. It contains a number of high-level
44+
coroutine-enabled primitives that this guide covers, including `async` and `await`.
45+
You need to add a dependency on `kotlinx-coroutines-core` module as explained
46+
[here](README.md#using-in-your-projects) to use primitives from this guide in your projects.
47+
3748
## Table of contents
3849

3950
<!--- TOC -->

0 commit comments

Comments
 (0)