From 73f7ae2ced33ce0feb981d846be518edb9ed20bb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Deleuze?= <sdeleuze@vmware.com>
Date: Thu, 14 Sep 2023 12:15:20 +0200
Subject: [PATCH] Document checkpointEvent extension property

See gh-22
---
 README.adoc | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.adoc b/README.adoc
index 04f294c..7942278 100644
--- a/README.adoc
+++ b/README.adoc
@@ -121,3 +121,16 @@ dependencies {
 ----
 
 This works for direct and transitive dependencies.
+
+=== Use a custom event to trigger the checkpoint
+
+By default, `org.springframework.boot.context.event.ApplicationReadyEvent` is used to trigger the checkpoint when the
+application is ready. It is possible to specify another event to trigger the checkpoint with the following Gradle
+configuration:
+
+[source,]
+----
+crSmokeTest {
+    checkpointEvent = "com.example.MyCustomEvent"
+}
+----