From f9d184f178af8e2103a9a650279423779e50272f Mon Sep 17 00:00:00 2001
From: Thijs Koppen <thijs.koppen@gmail.com>
Date: Mon, 28 Oct 2024 00:02:56 +0100
Subject: [PATCH] Release 0.0.2 checklist items

---
 README.md         | 21 ++++++++++++++++++++-
 gradle.properties |  2 +-
 2 files changed, 21 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index af41896..1098921 100644
--- 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
index 98972b1..ffec92e 100644
--- 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