Skip to content

Commit 211edcf

Browse files
author
Abduqodiri Qurbonzoda
committed
Update readme for 0.3 version
1 parent bec21e2 commit 211edcf

File tree

1 file changed

+39
-26
lines changed

1 file changed

+39
-26
lines changed

README.md

Lines changed: 39 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
Immutable collection interfaces and implementation prototypes for Kotlin.
66

7+
This is a multiplatform library providing implementations for `jvm`, `js`, `mingwX64`, `linuxX64`, `macosX64`, `iosX64`, `iosArm64`, `iosArm32` Kotlin targets.
8+
79
For further details see the [proposal](proposal.md).
810

911
## What's in this library
@@ -109,9 +111,39 @@ collection.mutate { some_actions_on(it) }
109111

110112
> Note that the library is experimental and the API is subject to change.
111113
112-
The library is published to [kotlinx](https://bintray.com/kotlin/kotlinx/kotlinx.collections.immutable) bintray repository.
114+
The library is published to [kotlinx](https://bintray.com/kotlin/kotlinx/kotlinx.collections.immutable) bintray repository and available in jcenter too.
115+
116+
The library depends on the Kotlin Standard Library of the version at least `1.3.50`.
117+
118+
### Gradle
119+
120+
Add the bintray repository:
121+
122+
```groovy
123+
repositories {
124+
jcenter()
125+
}
126+
```
127+
128+
In multiplatform projects add the following dependency to the common source set:
113129

114-
The library depends on the Kotlin Standard Library of the version at least `1.3.40`.
130+
```groovy
131+
kotlin {
132+
sourceSets {
133+
commonMain {
134+
dependencies {
135+
implementation("org.jetbrains.kotlinx:kotlinx-collections-immutable:0.3")
136+
}
137+
}
138+
}
139+
}
140+
```
141+
142+
To use the library in a JVM-only project add the platform to the artifact name, e.g.:
143+
144+
```groovy
145+
implementation("org.jetbrains.kotlinx:kotlinx-collections-immutable-jvm:0.3")
146+
```
115147

116148
### Maven
117149

@@ -122,9 +154,9 @@ Add the bintray repository to `<repositories>` section:
122154
<snapshots>
123155
<enabled>false</enabled>
124156
</snapshots>
125-
<id>kotlinx</id>
126-
<name>bintray</name>
127-
<url>https://dl.bintray.com/kotlin/kotlinx</url>
157+
<id>jcenter</id>
158+
<name>jcenter</name>
159+
<url>https://jcenter.bintray.com/</url>
128160
</repository>
129161
```
130162

@@ -133,30 +165,11 @@ Add dependencies (you can also add other modules that you need):
133165
```xml
134166
<dependency>
135167
<groupId>org.jetbrains.kotlinx</groupId>
136-
<artifactId>kotlinx-collections-immutable</artifactId>
137-
<version>0.2</version>
168+
<artifactId>kotlinx-collections-immutable-jvm</artifactId>
169+
<version>0.3</version>
138170
</dependency>
139171
```
140172

141-
### Gradle
142-
143-
Add the bintray repository:
144-
145-
```groovy
146-
repositories {
147-
maven {
148-
url "https://dl.bintray.com/kotlin/kotlinx"
149-
}
150-
}
151-
```
152-
153-
Add the dependency:
154-
155-
```groovy
156-
implementation 'org.jetbrains.kotlinx:kotlinx-collections-immutable:0.2'
157-
```
158-
159-
160173
## Building from source
161174

162175
> :information_source: To build this project you will need to have a path to JDK 6 specified with the `JDK_6` environment variable or gradle property.

0 commit comments

Comments
 (0)