Release 0.0.2 checklist items

Thijsiez · Oct 27, 2024 · f9d184f · f9d184f
1 parent dce5bb6
commit f9d184f
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -15,7 +15,26 @@ A dynamic, type-safe way to write your queries
 [Changelog](CHANGELOG.md) | [Contributing](CONTRIBUTING.md)
 
 ## Getting Started
-TODO
+Examples given use Gradle's Kotlin DSL  
+Add the KSP Gradle plugin to your build file
+```kotlin
+plugins {
+    id("com.google.devtools.ksp") version "2.0.21-1.0.25"
+}
+```
+Add this library to your build file and register it with KSP
+```kotlin
+dependencies {
+  implementation("ch.icken:panache-kotlin-dsl:0.0.2")
+  ksp("ch.icken:panache-kotlin-dsl:0.0.2")
+}
+```
+Optionally configure the behavior
+```kotlin
+ksp {
+  arg("addGeneratedAnnotation", "true")
+}
+```
 
 ## Requirements
 - Quarkus version `3.9.2` or newer

diff --git a/gradle.properties b/gradle.properties
@@ -16,7 +16,7 @@
 
 groupId=ch.icken
 artifactId=panache-kotlin-dsl
-version=0.0.1
+version=0.0.2
 
 #https://github.com/quarkusio/quarkus Pinned, do not change
 # Minimum, because of https://osv.dev/vulnerability/GHSA-f8h5-v2vg-46rr