Skip to content

Commit d3fb609

Browse files
committed
docs: update module table with all six modules and JDK requirements
1 parent 18494f3 commit d3fb609

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,18 @@ References:
99
This project is not an official release; APIs and behaviour may change as upstream evolves.
1010
You can find this code on [Maven Central](https://central.sonatype.com/artifact/io.github.simbo1905.json/java.util.json).
1111

12-
In addition to the core backport, this repo includes implementations of more advanced JSON technologies built on the `java.util.json` API.
12+
This repo is organized into the following modules:
1313

14-
| Submodule | What it is | Quick overview |
14+
| Module | What it is | JDK |
1515
| --- | --- | --- |
16-
| `json-java21-jtd` | JSON Type Definition (JTD) validator implementing RFC 8927 | [JTD validator](#json-type-definition-jtd-validator) |
17-
| `json-java21-jsonpath` | JsonPath query engine over `java.util.json` values | [JsonPath](#jsonpath) |
18-
19-
We welcome contributions to these incubating modules.
16+
| `json-java21` | Core `java.util.json` backport (parser, immutable types, `Json` API) | 21+ |
17+
| `json-java21-jtd` | JSON Type Definition (JTD) validator implementing RFC 8927, with stack-machine interpreter and optional bytecode codegen interface (`JtdValidator`) | 21+ |
18+
| `json-java21-jtd-codegen` | Bytecode code generator for JTD schemas using JDK 24+ ClassFile API (JEP 484); generates Java 21-compatible `.class` files for ~9x faster validation | 24+ (auto-skipped on JDK 21) |
19+
| `json-java21-jsonpath` | JsonPath query engine over `jdk.sandbox.java.util.json` values (Goessner-style: filters, slices, recursive descent, unions) | 21+ |
20+
| `json-compatibility-suite` | JSON Test Suite conformance reporter (tests against [nst/JSONTestSuite](https://github.com/nst/JSONTestSuite)) | 21+ |
21+
| `json-java21-api-tracker` | Daily upstream API drift detector — fetches OpenJDK sandbox sources, compares public API signatures, reports differences | 25+ |
22+
23+
We welcome contributions to the incubating modules.
2024

2125
## Usage Examples
2226

0 commit comments

Comments
 (0)