From 123fc18c750420ed57090560db453f4168694aa1 Mon Sep 17 00:00:00 2001
From: Adam Velebil <adam.velebil@yubico.com>
Date: Tue, 21 Jan 2025 11:55:46 +0100
Subject: [PATCH] update README files

---
 DesktopDemo/README.adoc | 27 +++++++++++++++++++++++++++
 README.adoc             |  4 +++-
 desktop/README.adoc     | 16 ++++++++++++++++
 3 files changed, 46 insertions(+), 1 deletion(-)
 create mode 100644 DesktopDemo/README.adoc
 create mode 100644 desktop/README.adoc

diff --git a/DesktopDemo/README.adoc b/DesktopDemo/README.adoc
new file mode 100644
index 00000000..74ef45af
--- /dev/null
+++ b/DesktopDemo/README.adoc
@@ -0,0 +1,27 @@
+= Desktop Demo Application
+:icons: font
+
+WARNING: This demo uses experimental APIs from the desktop module. The underlying APIs are not stable and may change in future versions without notice.
+
+This is a demonstration application showing how to use the desktop module of our SDK.
+It provides examples of basic usage and common implementation patterns.
+
+== Overview
+
+The DesktopDemo is a simple application that demonstrates:
+
+* Basic setup of a desktop application
+* Implementation of core functionality
+* Common usage patterns
+
+== Running the Demo
+
+[source,bash]
+----
+./gradlew :DesktopDemo:run
+----
+
+== Note
+
+This demo is built using the experimental desktop module. As the underlying APIs may change,
+please ensure you're using compatible versions of all modules.
\ No newline at end of file
diff --git a/README.adoc b/README.adoc
index a243bbb2..aa3d1790 100644
--- a/README.adoc
+++ b/README.adoc
@@ -77,7 +77,9 @@ developer https://support.yubico.com/support/tickets/new[support ticket] and
 our team will be happy to assist you.
 
 === Support for desktop apps
-WARNING: This is an introductory version and is not intended for production use.
+:icons: font
+
+WARNING: This is an experimental version and is not intended for production use.
 
 Since version 2.8.0, the SDK contains the desktop module, which provides concrete implementations
 of the core interfaces (USB and NFC connectivity) for building desktop Java applications.
diff --git a/desktop/README.adoc b/desktop/README.adoc
new file mode 100644
index 00000000..f4da345e
--- /dev/null
+++ b/desktop/README.adoc
@@ -0,0 +1,16 @@
+= Desktop Module
+:icons: font
+
+WARNING: This module is experimental. The API is not stable and may change in future versions without notice.
+
+This module provides concrete implementations of the core interfaces for desktop Java applications.
+It enables building desktop applications using our SDK.
+
+== Overview
+
+The desktop module is part of our SDK's desktop support, introduced in version 2.8.0.
+It implements the core interfaces necessary for desktop application development.
+
+== Usage
+
+See the DesktopDemo module for examples of how to use this implementation.
\ No newline at end of file