Skip to content

Commit d943174

Browse files
committed
docs: clarify repo purpose and link submodule overviews
1 parent 6c2fe83 commit d943174

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,14 @@ 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-
To kick the tyres on the New JSON API this repo includes a JSON Type Definition (JTD) Validator implementing RFC 8927, released on Maven Central as part of this project.
12+
In addition to the core backport, this repo includes implementations of more advanced JSON technologies built on the `java.util.json` API.
1313

14-
We welcome contributions to the JTD Validator incubating within this repo.
14+
| Submodule | What it is | Quick overview |
15+
| --- | --- | --- |
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.
1520

1621
## Usage Examples
1722

json-java21-jtd/src/test/java/json/java21/jtd/JtdPropertyTest.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -383,6 +383,7 @@ private static Arbitrary<JtdTestSchema> nullableSchemaArbitrary(int depth) {
383383
return jtdSchemaArbitrary(depth - 1).map(NullableSchema::new);
384384
}
385385

386+
@SuppressWarnings("unused")
386387
@Provide
387388
Arbitrary<JtdTestSchema> jtdSchemas() {
388389
return jtdSchemaArbitrary(3);

0 commit comments

Comments
 (0)