Skip to content

Commit 53ee45d

Browse files
Abduqodiri Qurbonzodaqurbonzoda
Abduqodiri Qurbonzoda
authored andcommitted
Update README.md with the 0.3.0 release
1 parent dabda64 commit 53ee45d

File tree

1 file changed

+17
-38
lines changed

1 file changed

+17
-38
lines changed

README.md

+17-38
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22
[![GitHub license](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](https://www.apache.org/licenses/LICENSE-2.0)
33
[![Download](https://api.bintray.com/packages/kotlin/kotlinx/kotlinx.benchmark/images/download.svg) ](https://bintray.com/kotlin/kotlinx/kotlinx.benchmark/_latestVersion)
44

5+
6+
> **_NOTE:_**   The latest version of the library changes how the plugin and runtime library dependencies are declared:
7+
> * The library runtime is published to Maven Central and no longer published to Bintray.
8+
> * The Gradle plugin is published to Gradle Plugin Portal
9+
> * The Gradle plugin id has changed to `org.jetbrains.kotlinx.benchmark`
10+
> * The library runtime artifact id has changed to `kotlinx-benchmark-runtime`
11+
12+
513
**kotlinx.benchmark** is a toolkit for running benchmarks for multiplatform code written in Kotlin
614
and running on the next supported targets: JVM, JavaScript.
715

@@ -14,45 +22,18 @@ the hoods to run benchmarks on JVM.
1422

1523
# Requirements
1624

17-
Gradle 6.0 or newer
25+
Gradle 6.8 or newer
1826

1927
Kotlin 1.4.30 or newer
2028

2129
# Gradle plugin
2230

23-
Add repository in `settings.gradle` to enable bintray repository for plugin lookup
24-
25-
```groovy
26-
pluginManagement {
27-
repositories {
28-
maven { url 'https://dl.bintray.com/kotlin/kotlinx' }
29-
gradlePluginPortal()
30-
}
31-
}
32-
```
33-
3431
Use plugin in `build.gradle`:
3532

3633
```groovy
3734
plugins {
38-
id 'kotlinx.benchmark' version "0.2.0-dev-20"
39-
}
40-
```
41-
42-
Alternatively, you can use build script dependencies and "apply plugin" syntax:
43-
44-
```groovy
45-
buildscript {
46-
repositories {
47-
48-
maven { url 'https://dl.bintray.com/kotlin/kotlinx' }
49-
}
50-
dependencies {
51-
classpath "org.jetbrains.kotlinx:kotlinx.benchmark.gradle:0.2.0-dev-20"
52-
}
35+
id 'org.jetbrains.kotlinx.benchmark' version '0.3.0'
5336
}
54-
55-
apply plugin: 'kotlinx.benchmark'
5637
```
5738

5839
For Kotlin/JS specify building `nodejs` flavour:
@@ -89,30 +70,28 @@ then you don't have to make benchmark classes and methods `open`.
8970

9071
# Runtime Library
9172

92-
You need a runtime library with annotations and code that will run benchmarks on JavaScript and Native platforms.
73+
You need a runtime library with annotations and code that will run benchmarks.
9374

75+
Enable Maven Central for dependencies lookup:
9476
```groovy
9577
repositories {
96-
maven { url 'https://dl.bintray.com/kotlin/kotlinx' }
78+
mavenCentral()
9779
}
80+
```
9881

82+
Add the runtime to dependencies of the platform source set, e.g.:
83+
```
9984
kotlin {
10085
sourceSets {
10186
commonMain {
10287
dependencies {
103-
implementation("org.jetbrains.kotlinx:kotlinx-benchmark-runtime:0.2.0-dev-20")
88+
implementation("org.jetbrains.kotlinx:kotlinx-benchmark-runtime:0.3.0")
10489
}
10590
}
10691
}
10792
}
10893
```
10994

110-
To use the library in a JVM-only project add the platform to the artifact name, e.g.:
111-
112-
```groovy
113-
implementation("org.jetbrains.kotlinx:kotlinx-benchmark-runtime-jvm:0.2.0-dev-20")
114-
```
115-
11695
# Configuration
11796

11897
In a `build.gradle` file create ` benchmark` section, and inside it add a `targets` section.

0 commit comments

Comments
 (0)