diff --git a/docs/programmatic-usage.md b/docs/programmatic-usage.md index 2edbd9b..fdeaf44 100644 --- a/docs/programmatic-usage.md +++ b/docs/programmatic-usage.md @@ -41,6 +41,24 @@ The main types involved in programmatic usage are: - `FrequencyTrieBuilders` for reconstructing a mutable builder from a compiled trie, - `ReductionMode` and `ReductionSettings` for controlling compilation semantics. +## Java module system (JPMS) + +The core artifact is published as an explicit JPMS module: + +```java +module org.egothor.radixor; +``` + +A named consuming module uses: + +```java +module example.consumer { + requires org.egothor.radixor; +} +``` + +The core module is standalone and can be consumed directly as a normal Java module. + ## Recommended reading order For most developers, the best order is: diff --git a/src/main/java/module-info.java b/src/main/java/module-info.java new file mode 100644 index 0000000..492ad04 --- /dev/null +++ b/src/main/java/module-info.java @@ -0,0 +1,5 @@ +module org.egothor.radixor { + requires java.logging; + + exports org.egothor.stemmer; +}