Skip to content

Commit

Permalink
update README files
Browse files Browse the repository at this point in the history
  • Loading branch information
AdamVe committed Jan 21, 2025
1 parent 47b2420 commit 123fc18
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 1 deletion.
27 changes: 27 additions & 0 deletions DesktopDemo/README.adoc
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 3 additions & 1 deletion README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
16 changes: 16 additions & 0 deletions desktop/README.adoc
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 123fc18

Please sign in to comment.