Skip to content

Commit 519381a

Browse files
committed
Document snapshot usage.
1 parent 1b1c823 commit 519381a

File tree

2 files changed

+40
-2
lines changed

2 files changed

+40
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
[![Kotlin](https://img.shields.io/badge/Kotlin-2.2.10-%237F52FF.svg?style=flat-square&logo=kotlin&logoColor=%237F52FF)](https://kotlinlang.org/)
44
[![Kotest](https://img.shields.io/badge/Kotest-6.0.3-%35ED35.svg?style=flat-square&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxNiIgaGVpZ2h0PSIxNiI+PHBhdGggc3R5bGU9ImZpbGw6IzM1ZWQzNSIgZD0iTTEyIDJoNGwtOCA4IDQgNEg0di00TDAgNmg4WiIvPjwvc3ZnPg==)](https://kotest.io/)
55
[![Build Status](https://img.shields.io/github/actions/workflow/status/Jadarma/advent-of-code-kotlin/build.yml?style=flat-square&logo=github&label=Build&logoColor=%23171515)](https://github.com/Jadarma/advent-of-code-kotlin/actions/workflows/build.yml)
6-
[![Maven Central](https://img.shields.io/maven-central/v/io.github.jadarma.aockt/aockt-test?style=flat-square&color=blue&logo=apachemaven&logoColor=blue&label=Maven%20Central)](https://central.sonatype.com/namespace/io.github.jadarma.aockt)
7-
[![Snapshot](https://img.shields.io/nexus/s/io.github.jadarma.aockt/aockt-test?server=https%3A%2F%2Fs01.oss.sonatype.org&style=flat-square&color=orange&logo=apachemaven&logoColor=orange&label=Snapshot)](https://s01.oss.sonatype.org/content/repositories/snapshots/io/github/jadarma/aockt/)
6+
[![Maven Central](https://img.shields.io/maven-central/v/io.github.jadarma.aockt/aockt-test?style=flat-square&logo=apachemaven&logoColor=blue&label=Maven%20Central&color=blue)](https://central.sonatype.com/namespace/io.github.jadarma.aockt)
7+
[![Maven SNAPSHOT](https://img.shields.io/maven-metadata/v?metadataUrl=https%3A%2F%2Fcentral.sonatype.com%2Frepository%2Fmaven-snapshots%2Fio%2Fgithub%2Fjadarma%2Faockt%2Faockt-test%2Fmaven-metadata.xml&strategy=latestProperty&style=flat-square&logo=apachemaven&logoColor=orange&label=Snapshot&color=orange)](https://jadarma.github.io/advent-of-code-kotlin/overview.html#snapshot)
88

99
AocKt _(short for Advent of Code - Kotlin)_ is a simple library that makes running and testing your Kotlin solutions to
1010
[Advent of Code](https://adventofcode.com) puzzles a breeze.

docs/topics/overview.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ for testing AoC puzzle solutions with minimal boilerplate.
1818

1919
<tabs>
2020
<tab id="template" title="AocKt Template Project">
21+
2122
For your convenience, there is an
2223
<a href="https://github.com/Jadarma/advent-of-code-kotlin-template"><code>advent-of-code-kotlin-template</code></a>
2324
repository which you can use to generate your own solutions repo.
@@ -28,6 +29,7 @@ _(If you need a working example, check out [my solutions repo](https://github.co
2829

2930
</tab>
3031
<tab id="standalone" title="Standalone Gradle Project">
32+
3133
To add AocKt to your existing project, simply add the dependencies and configure your unit tests to run with Kotest:
3234

3335
```kotlin
@@ -49,6 +51,42 @@ tasks.test {
4951
useJUnitPlatform()
5052
}
5153
```
54+
</tab>
55+
<tab id="snapshot" title="SNAPSHOT Builds">
56+
57+
To consume pre-release builds, you must register the snapshot repository.\
58+
Replace `x.x.x-SNAPSHOT` with the version from the badge below _(if it exists)_:
59+
60+
![Maven SNAPSHOT](https://img.shields.io/maven-metadata/v?metadataUrl=https%3A%2F%2Fcentral.sonatype.com%2Frepository%2Fmaven-snapshots%2Fio%2Fgithub%2Fjadarma%2Faockt%2Faockt-test%2Fmaven-metadata.xml&strategy=latestProperty&style=flat-square&logo=apachemaven&logoColor=orange&label=Snapshot&color=orange)
61+
62+
```kotlin
63+
plugins {
64+
kotlin("jvm") version "%kotlin-version%"
65+
}
66+
67+
repositories {
68+
mavenCentral()
69+
maven {
70+
url = uri("https://central.sonatype.com/repository/maven-snapshots/")
71+
content { includeGroup("io.github.jadarma.aockt") }
72+
}
73+
}
74+
75+
dependencies {
76+
implementation("io.github.jadarma.aockt:aockt-core:x.x.x-SNAPSHOT")
77+
testImplementation("io.github.jadarma.aockt:aockt-test:x.x.x-SNAPSHOT")
78+
testImplementation("io.kotest:kotest-runner-junit5:%kotest-version%")
79+
}
80+
81+
tasks.test {
82+
useJUnitPlatform()
83+
}
84+
```
85+
86+
**PS:**
87+
You can also [submit an issue](https://github.com/Jadarma/advent-of-code-kotlin/issues) if you find bugs or have suggestions.
88+
Thank you for trying out the latest development build! 💚
89+
5290
</tab>
5391
</tabs>
5492

0 commit comments

Comments
 (0)