Update README with latest release information

This commit is contained in:
Brian Norman
2020-02-10 09:27:03 -06:00
parent 7a9ea0ba18
commit 2a9cf5bf49
+13 -28
View File
@@ -1,5 +1,7 @@
# kotlin-power-assert # kotlin-power-assert
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.bnorm.power/kotlin-power-assert/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.bnorm.power/kotlin-power-assert)
Kotlin Compiler Plugin which high-jacks Kotlin assert function calls and Kotlin Compiler Plugin which high-jacks Kotlin assert function calls and
transforms them similar to [Groovy's Power Assert feature][groovy-power-assert]. transforms them similar to [Groovy's Power Assert feature][groovy-power-assert].
This plugin uses the new IR backend for the Kotlin compiler. This plugin uses the new IR backend for the Kotlin compiler.
@@ -49,6 +51,17 @@ assert(hello.length == "World".substring(1, 4).length)
at <stacktrace> at <stacktrace>
``` ```
## Gradle Plugin
Builds of the Gradle plugin are available through the
[Gradle Plugin Portal][kotlin-power-assert-gradle].
```groovy
plugins {
id "com.bnorm.power.kotlin-power-assert" version "0.1.0"
}
```
## Kotlin IR ## Kotlin IR
Using this compiler plugin only works if the code is compiled using IR. This can Using this compiler plugin only works if the code is compiled using IR. This can
@@ -63,33 +76,5 @@ compileTestKotlin {
} }
``` ```
## Project Snapshots
Snapshot builds of the Kotlin compiler plugin are available through Sonatype
Snapshot repository. Builds of the Gradle plugin are also available through the
[Gradle Plugin Portal][kotlin-power-assert-gradle].
```groovy
buildscript {
repositories {
maven {
url "https://oss.sonatype.org/content/repositories/snapshots"
}
}
dependencies {
classpath "com.bnorm.power:kotlin-power-assert-gradle:0.1.0-SNAPSHOT"
}
}
apply plugin: "com.bnorm.power.kotlin-power-assert"
repositories {
// Required to find Kotlin compiler plugin as it is not bundled with Gradle plugin
maven {
url "https://oss.sonatype.org/content/repositories/snapshots"
}
}
```
[groovy-power-assert]: https://groovy-lang.org/testing.html#_power_assertions [groovy-power-assert]: https://groovy-lang.org/testing.html#_power_assertions
[kotlin-power-assert-gradle]: https://plugins.gradle.org/plugin/com.bnorm.power.kotlin-power-assert [kotlin-power-assert-gradle]: https://plugins.gradle.org/plugin/com.bnorm.power.kotlin-power-assert