Skip to content

Commit edd584a

Browse files
authored
Improve readability. (#2563)
- Add articles. - Fix words. - Fix capitalization.
1 parent 1efc9f1 commit edd584a

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
[![Slack channel](https://img.shields.io/badge/chat-slack-green.svg?logo=slack)](https://kotlinlang.slack.com/messages/coroutines/)
88

99
Library support for Kotlin coroutines with [multiplatform](#multiplatform) support.
10-
This is a companion version for Kotlin `1.4.30` release.
10+
This is a companion version for the Kotlin `1.4.30` release.
1111

1212
```kotlin
1313
suspend fun main() = coroutineScope {
@@ -75,7 +75,7 @@ suspend fun main() = coroutineScope {
7575

7676
## Using in your projects
7777

78-
The libraries are published to [kotlinx](https://bintray.com/kotlin/kotlinx/kotlinx.coroutines) bintray repository,
78+
The libraries are published to [kotlinx](https://bintray.com/kotlin/kotlinx/kotlinx.coroutines) Bintray repository,
7979
linked to [JCenter](https://bintray.com/bintray/jcenter?filterByPkgName=kotlinx.coroutines) and
8080
pushed to [Maven Central](https://search.maven.org/#search%7Cga%7C1%7Cg%3Aorg.jetbrains.kotlinx%20a%3Akotlinx-coroutines*).
8181

@@ -148,16 +148,16 @@ Make sure that you have `mavenCentral()` in the list of repositories.
148148
### Android
149149

150150
Add [`kotlinx-coroutines-android`](ui/kotlinx-coroutines-android)
151-
module as dependency when using `kotlinx.coroutines` on Android:
151+
module as a dependency when using `kotlinx.coroutines` on Android:
152152

153153
```groovy
154154
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.4.3'
155155
```
156156

157-
This gives you access to Android [Dispatchers.Main]
158-
coroutine dispatcher and also makes sure that in case of crashed coroutine with unhandled exception this
159-
exception is logged before crashing Android application, similarly to the way uncaught exceptions in
160-
threads are handled by Android runtime.
157+
This gives you access to the Android [Dispatchers.Main]
158+
coroutine dispatcher and also makes sure that in case of a crashed coroutine with an unhandled exception that
159+
this exception is logged before crashing the Android application, similarly to the way uncaught exceptions in
160+
threads are handled by the Android runtime.
161161

162162
#### R8 and ProGuard
163163

@@ -168,7 +168,7 @@ For more details see ["Optimization" section for Android](ui/kotlinx-coroutines-
168168

169169
The `kotlinx-coroutines-core` artifact contains a resource file that is not required for the coroutines to operate
170170
normally and is only used by the debugger. To exclude it at no loss of functionality, add the following snippet to the
171-
`android` block in your gradle file for the application subproject:
171+
`android` block in your Gradle file for the application subproject:
172172
```groovy
173173
packagingOptions {
174174
exclude "DebugProbesKt.bin"
@@ -180,7 +180,7 @@ packagingOptions {
180180
Core modules of `kotlinx.coroutines` are also available for
181181
[Kotlin/JS](https://kotlinlang.org/docs/reference/js-overview.html) and [Kotlin/Native](https://kotlinlang.org/docs/reference/native-overview.html).
182182

183-
In common code that should get compiled for different platforms, you can add dependency to `kotlinx-coroutines-core` right to the `commonMain` source set:
183+
In common code that should get compiled for different platforms, you can add a dependency to `kotlinx-coroutines-core` right to the `commonMain` source set:
184184
```groovy
185185
commonMain {
186186
dependencies {
@@ -189,7 +189,7 @@ commonMain {
189189
}
190190
```
191191

192-
No more additional dependencies is needed, platform-specific artifacts will be resolved automatically via Gradle metadata available since Gradle 5.3.
192+
No more additional dependencies are needed, platform-specific artifacts will be resolved automatically via Gradle metadata available since Gradle 5.3.
193193

194194
Platform-specific dependencies are recommended to be used only for non-multiplatform projects that are compiled only for target platform.
195195

@@ -207,11 +207,11 @@ the target Kotlin/Native platform. [List of currently supported targets](https:/
207207

208208

209209
Only single-threaded code (JS-style) on Kotlin/Native is supported in stable versions.
210-
Additionally, special `-native-mt` version is released on a regular basis, for the state of multi-threaded coroutines support
210+
Additionally, a special `-native-mt` version is released on a regular basis, for the state of multi-threaded coroutines support
211211
please follow the [corresponding issue](https://github.com/Kotlin/kotlinx.coroutines/issues/462) for the additional details.
212212

213213
Since Kotlin/Native does not generally provide binary compatibility between versions,
214-
you should use the same version of Kotlin/Native compiler as was used to build `kotlinx.coroutines`.
214+
you should use the same version of the Kotlin/Native compiler as was used to build `kotlinx.coroutines`.
215215

216216
## Building and Contributing
217217

0 commit comments

Comments
 (0)