Skip to content

Commit

Permalink
docs: clarify readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gotson committed Aug 26, 2024
1 parent df83b09 commit 9002ff6
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,15 @@

# NightMonkeys

A collection of ImageIO plugins, adding support for newer image formats. NightMonkeys uses the newer Foreign Linker API
available in JDK 22 to access native libraries.
A collection of ImageIO plugins, adding support for newer image formats. NightMonkeys uses the Foreign Linker API
available since JDK 22 to access native libraries.

## How it works

NightMonkeys plugins are released as multi-release JARs:

- with Java < 22, a no-op version of the plugin will unregister itself on load, basically doing nothing
- with Java 22, the plugin will be available
- the plugins are not compatible with other Java versions, as the Foreign Linker APIs are still changing
- with Java 22+, the plugin will be available

This lets you add the dependencies in your project whatever the JDK used, and still enable the plugin at runtime if the necessary JDK is used.

Expand Down

0 comments on commit 9002ff6

Please sign in to comment.