Skip to content

Commit 5362626

Browse files
ThorFuchsclaude
andauthored
docs: update README for 1.8.0 release (#82)
Point the latest-stable banner, release pin, qualification receipt, release notes, installation requirement, exact-interface DocC links, catalog/CLI version mentions and performance-hold paragraph at published 1.8.0 (66718f1). Describe JSONLocatedTopLevelArraySequence in the pull-stream section. Swift example fences are unchanged. Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
1 parent 5353da4 commit 5362626

1 file changed

Lines changed: 25 additions & 18 deletions

File tree

‎README.md‎

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@ partially read document would change the meaning of your data.
1313

1414
[Read the documentation →](https://thorfuchs.github.io/Swift-JSON/)
1515

16-
The latest stable release is [**Swift-JSON 1.7.1**](https://github.com/ThorFuchs/Swift-JSON/releases/tag/1.7.1).
17-
This patch fixes JSONSchema resource discovery in SwiftPM's native test host.
16+
The latest stable release is [**Swift-JSON 1.8.0**](https://github.com/ThorFuchs/Swift-JSON/releases/tag/1.8.0).
17+
This minor release adds located root-array streaming: `JSONLocatedTopLevelArraySequence`
18+
reports each element's original UTF-8 byte span alongside its value.
1819
The 1.7.0 release brought source-attached Inspection snapshots, projections and
1920
graphs, JSONTransform and the optional JSONValueDSL/JSONSchemaDSL products together.
2021
Choose from twelve library products plus the `swift-json` executable. Thirteen
@@ -24,11 +25,11 @@ Maintained by [Thorsten Fuchs](https://github.com/ThorFuchs). Swift-JSON follows
2425
semantic versioning. Use a released version and retain `Package.resolved` for
2526
reproducible builds; `main` tracks ongoing development.
2627

27-
Release 1.7.1 is pinned to
28-
[`983b538b15f30e73fb221f7b671a5049c03bf978`](https://github.com/ThorFuchs/Swift-JSON/commit/983b538b15f30e73fb221f7b671a5049c03bf978).
28+
Release 1.8.0 is pinned to
29+
[`66718f11514d8c555f6a6b0ecc738e5029405a55`](https://github.com/ThorFuchs/Swift-JSON/commit/66718f11514d8c555f6a6b0ecc738e5029405a55).
2930
Its assets include the exact source archive, compiled documentation, checksums and
30-
a [source-bound prepublication qualification receipt](https://github.com/ThorFuchs/Swift-JSON/releases/download/1.7.1/Swift-JSON-1.7.1-qualification.json).
31-
See the [release notes](Documentation/ReleaseNotes/1.7.1.md) and
31+
a [source-bound prepublication qualification receipt](https://github.com/ThorFuchs/Swift-JSON/releases/download/1.8.0/Swift-JSON-1.8.0-qualification.json).
32+
See the [release notes](Documentation/ReleaseNotes/1.8.0.md) and
3233
[forward roadmap](Documentation/ReleaseRoadmap.md) for scope and planned work.
3334

3435
[1.6.1](https://github.com/ThorFuchs/Swift-JSON/releases/tag/1.6.1) remains a separate
@@ -129,7 +130,7 @@ earlier stage receipts retain their original source and unfinished gates.
129130
Add the package to your `Package.swift`:
130131

131132
```swift
132-
.package(url: "https://github.com/ThorFuchs/Swift-JSON.git", from: "1.7.1")
133+
.package(url: "https://github.com/ThorFuchs/Swift-JSON.git", from: "1.8.0")
133134
```
134135

135136
Then add products to your target dependencies:
@@ -143,7 +144,7 @@ Add `JSONStreaming`, `JSONPatch`, `JSONHTML`, `JSONBridges`, `JSONNavigation`,
143144
`JSONSchemaExamples`, `JSONInspection`, `JSONTransform`, `JSONValueDSL` or
144145
`JSONSchemaDSL` in the same way when needed. A local checkout can use
145146
`.package(path: "../Swift-JSON")`. The requirement above accepts compatible 1.x
146-
releases from 1.7.1; use `exact: "1.7.1"` when reproducing this release.
147+
releases from 1.8.0; use `exact: "1.8.0"` when reproducing this release.
147148
See the [core consumer](Examples/Consumer) for a complete buildable manifest.
148149
The website tracks `main`; release assets include compiled DocC catalogs for the
149150
exact released source.
@@ -464,6 +465,11 @@ producer queue. Root-array elements and syntax events remain provisional until
464465
completion. A document completes only after its closing syntax, trailing whitespace
465466
and EOF. `JSONValueSequence` waits for its framing boundary before yielding a value;
466467
`NDJSONValueSequence` rejects blank/malformed physical records and never skips them.
468+
Since 1.8.0, `JSONLocatedTopLevelArraySequence` drives the same root-array reader and
469+
also yields each element's `JSONSourceSpan`: zero-based half-open UTF-8 byte offsets
470+
in the complete stream, excluding whitespace and separators. It retains no original
471+
bytes; keep an immutable source to slice raw records, and treat spans as provisional
472+
until completion.
467473

468474
`JSONAsyncWriter` awaits acceptance of every bounded chunk. Error or cancellation
469475
stops later pulls/writes; previously accepted bytes remain accepted. Stage them in a
@@ -566,14 +572,14 @@ Browse the [public documentation site](https://thorfuchs.github.io/Swift-JSON/):
566572
[JSONValueDSL](https://thorfuchs.github.io/Swift-JSON/JSONValueDSL/documentation/jsonvaluedsl/) and
567573
[JSONSchemaDSL](https://thorfuchs.github.io/Swift-JSON/JSONSchemaDSL/documentation/jsonschemadsl/).
568574
The site tracks `main` and publishes only after all four native CI lanes pass.
569-
For the exact 1.7.1 interface, use its
570-
[tagged source documentation](https://github.com/ThorFuchs/Swift-JSON/tree/1.7.1/Sources)
571-
or download the [compiled DocC archive](https://github.com/ThorFuchs/Swift-JSON/releases/download/1.7.1/Swift-JSON-1.7.1-DocC.tar.gz)
572-
and [documentation manifest](https://github.com/ThorFuchs/Swift-JSON/releases/download/1.7.1/Swift-JSON-1.7.1-DocC.MANIFEST.sha256).
575+
For the exact 1.8.0 interface, use its
576+
[tagged source documentation](https://github.com/ThorFuchs/Swift-JSON/tree/1.8.0/Sources)
577+
or download the [compiled DocC archive](https://github.com/ThorFuchs/Swift-JSON/releases/download/1.8.0/Swift-JSON-1.8.0-DocC.tar.gz)
578+
and [documentation manifest](https://github.com/ThorFuchs/Swift-JSON/releases/download/1.8.0/Swift-JSON-1.8.0-DocC.MANIFEST.sha256).
573579
Historical preparation receipts retain their original scope.
574580

575581
The [documentation index](Documentation/README.md) links the behavior contracts.
576-
Release 1.7.1 includes thirteen catalogs: twelve library references and the
582+
Release 1.8.0 includes thirteen catalogs: twelve library references and the
577583
[shared JSONDSLCore structure reference](https://thorfuchs.github.io/Swift-JSON/JSONDSLCore/documentation/jsondslcore/).
578584
They provide public API references, focused guides, parameter descriptions and
579585
failure contracts, compiled from native Swift public symbol graphs.
@@ -609,11 +615,12 @@ The 1.1 candidate's separate matched stream comparison is **15.76% slower**; its
609615
retains the accepted disposition. The [additional QA wave](Documentation/Architecture/Release1.1/QA.md)
610616
records conformance coverage and the Base64 accounting correction.
611617

612-
For 1.7.1, controlled Navigation performance G4 remains **HOLD**, with zero accepted
618+
For 1.8.0, controlled Navigation performance G4 remains **HOLD**, with zero accepted
613619
controlled timing samples. The original 1.7.0 Transform P4 exception and incomplete
614620
historical sampling remain recorded for unchanged workloads; neither is a new
615621
measured pass. No new speed, throughput, allocation-efficiency or RSS claim is made.
616-
See the [1.7.1 qualification receipt](https://github.com/ThorFuchs/Swift-JSON/releases/download/1.7.1/Swift-JSON-1.7.1-qualification.json)
622+
See the [1.8.0 qualification receipt](https://github.com/ThorFuchs/Swift-JSON/releases/download/1.8.0/Swift-JSON-1.8.0-qualification.json),
623+
[1.7.1 qualification receipt](https://github.com/ThorFuchs/Swift-JSON/releases/download/1.7.1/Swift-JSON-1.7.1-qualification.json)
617624
and [1.7.0 qualification receipt](https://github.com/ThorFuchs/Swift-JSON/releases/download/1.7.0/Swift-JSON-1.7.0-qualification.json).
618625

619626
## Contributing, support and licensing
@@ -646,7 +653,7 @@ inputs retain their applicable [notices](NOTICE), [third-party notices](THIRD_PA
646653

647654
## Command-line tool (released in 1.5.0)
648655

649-
`swift-json` accompanies the twelve libraries in 1.7.1. It provides strict
656+
`swift-json` accompanies the twelve libraries in 1.8.0. It provides strict
650657
formatting, validation, Pointer selection, staged
651658
Patch and qualified HTML/text/Markdown rendering. See the [CLI plan](Documentation/Architecture/Release1.4/Plan.md)
652659
and [foundation contract](Documentation/Architecture/Release1.4/Foundation.md)
@@ -667,7 +674,7 @@ swift build -c release --product swift-json
667674

668675
### Run exact pull queries
669676

670-
Release 1.7.1 has twelve libraries plus the executable, with no external root
677+
Release 1.8.0 has twelve libraries plus the executable, with no external root
671678
dependencies. Build the selected source version
672679
with Swift6.4+ (`swift build -c release --product swift-json`), or use
673680
`swift run swift-json help`. Native qualification requires macOS/SDK27+.
@@ -689,7 +696,7 @@ See the [CLI reference](Documentation/Architecture/Release1.4/CLIReference.md),
689696
[integration contract](Documentation/Architecture/Release1.4/Integration.md) and
690697
[acceptance ledger](Documentation/Architecture/Release1.4/Acceptance.json).
691698
The frozen 1.5.0 CLI reports `1.4.0-dev` and revision `unknown`, as disclosed in
692-
its release notes. Version 1.7.1 reports `1.7.1` and a
699+
its release notes. Version 1.8.0 reports `1.8.0` and a
693700
deterministic source digest; see the [CLI guide](Documentation/CLI.md).
694701
Versioned release assets identify the exact qualified platform and source scope.
695702

0 commit comments

Comments
 (0)