Skip to content

Commit 4424737

Browse files
committed
README: clarify what are the required dependencies and where to get them.
Fixes #15
1 parent c4ad15f commit 4424737

File tree

1 file changed

+29
-14
lines changed

1 file changed

+29
-14
lines changed

README.md

+29-14
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ generated by coroutine body containing `yield` suspension points
1010

1111
## Examples
1212
### Async
13+
1314
```kotlin
1415
import kotlinx.coroutines.async
1516
import java.util.concurrent.CompletableFuture
@@ -35,6 +36,7 @@ Bear in mind that `async` library actively uses `CompletableFuture` from JDK 8,
3536
it will not work with earlier versions.
3637

3738
### Generate
39+
3840
```kotlin
3941
import kotlinx.coroutines.generate
4042

@@ -50,6 +52,7 @@ fun main(args: Array<String>) {
5052
```
5153

5254
### RxJava
55+
5356
```kotlin
5457
import kotlinx.coroutines.asyncRx
5558
import retrofit2.Retrofit
@@ -90,9 +93,20 @@ fun main(args: Array<String>) {
9093
For more examples you can look at `kotlinx-coroutines-async-example-ui`
9194
and `kotlinx-coroutines-rx-example` samples projects or in tests directories.
9295

93-
## Maven
96+
## Using in your projects
97+
98+
> Note that these libraries are experimental and are subject to change.
99+
100+
The libraries are published to [kotlin-eap-1.1](https://bintray.com/kotlin/kotlin-eap-1.1/kotlinx.coroutines) bintray repository.
101+
102+
These libraries require kotlin compiler version to be at least `1.1-M04` and
103+
require kotlin runtime of the same version as a dependency, which can be obtained from the same repository.
104+
94105

95-
Add the bintray repository
106+
### Maven
107+
108+
Add the bintray repository to `<repositories>` section (and also add `pluginRepository` to `<pluginRepositories>`,
109+
if you're willing to get `kotlin-maven-plugin` from there):
96110

97111
```xml
98112
<repository>
@@ -105,7 +119,7 @@ Add the bintray repository
105119
</repository>
106120
```
107121

108-
Add dependencies:
122+
Add dependencies (you can add just those of them that you need):
109123

110124
```xml
111125
<dependency>
@@ -125,9 +139,19 @@ Add dependencies:
125139
</dependency>
126140
```
127141

128-
## Gradle
142+
### Gradle
129143

130-
Just add dependencies:
144+
Add the bintray repository (and also add it to `buildScript` section, if you're willing to get `kotlin-gradle-plugin` from there):
145+
146+
```groovy
147+
repositories {
148+
maven {
149+
url "http://dl.bintray.com/kotlin/kotlin-eap-1.1"
150+
}
151+
}
152+
```
153+
154+
Add dependencies (you can add just those of them that you need):
131155

132156
```groovy
133157
compile 'org.jetbrains.kotlinx:kotlinx-coroutines-generate:0.2-beta'
@@ -137,12 +161,3 @@ compile 'org.jetbrains.kotlinx:kotlinx-coroutines-rx:0.2-beta'
137161

138162
*NB:* As `async` library is built upon `CompletableFuture` it requires JDK 8 (24 Android API level)
139163

140-
Also you should include our bintray repository:
141-
142-
```groovy
143-
repositories {
144-
maven {
145-
url "http://dl.bintray.com/kotlin/kotlin-eap-1.1"
146-
}
147-
}
148-
```

0 commit comments

Comments
 (0)