From 929be882980ce25ab89ecda16bb4af24d9c11b40 Mon Sep 17 00:00:00 2001 From: Iwan Eising Date: Fri, 18 Sep 2026 20:07:52 +0400 Subject: [PATCH] docs(api-only-transcriberj-restdocs): describe the emitter as released The README still said 'Not released yet', and that the TranscriberJ it needs is '0.0.0 until both are released'. The emitter is at 0.1.1; it is built against TranscriberJ 0.3.0 and used with 0.3.3 in the examples. The Using-it snippet now names the version instead of , which the release workflow's existing substitution keeps current. --- api-only-transcriberj-restdocs/README.adoc | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/api-only-transcriberj-restdocs/README.adoc b/api-only-transcriberj-restdocs/README.adoc index b569c0f..3a5b1d3 100644 --- a/api-only-transcriberj-restdocs/README.adoc +++ b/api-only-transcriberj-restdocs/README.adoc @@ -6,8 +6,6 @@ The Spring REST Docs emitter of the https://github.com/Arc-E-Tect/SoftwareEngineeringDoneRight-API/tree/main/api-only-transcriberj[API-Only TranscriberJ ↗]: for every class the TranscriberJ generates from an API contract, a companion holding its REST Docs field descriptors and snippets. -Not released yet. - // tag::root[] == Artifact Coordinates @@ -25,7 +23,8 @@ Not released yet. |Requirement |Version |Java |21+ |Gradle |9.x -|API-Only TranscriberJ |the version this emitter was built against, `0.0.0` until both are released +|API-Only TranscriberJ |`0.3.0` or newer: it is built against `0.3.0`, and the examples use it with `0.3.3`. +Until the TranscriberJ's `1.0.0`, a release may change the emitter interface; its changelog says when. |Spring REST Docs |4.x, in the project's test source sets |=== @@ -36,7 +35,7 @@ Add it to the TranscriberJ's emitter configuration: [source,groovy] ---- dependencies { - transcriberjEmitters 'com.arc-e-tect:api-only-transcriberj-restdocs:' + transcriberjEmitters 'com.arc-e-tect:api-only-transcriberj-restdocs:0.1.1' } ----