Skip to content

docs: remove stale sax-js references from README - #270

Merged
palemieux merged 1 commit into
sandflow:integration/v2from
littlespex:docs/readme-remove-sax
Sep 1, 2026
Merged

docs: remove stale sax-js references from README#270
palemieux merged 1 commit into
sandflow:integration/v2from
littlespex:docs/readme-remove-sax

Conversation

@littlespex

Copy link
Copy Markdown

Commit 665e022 removed sax from the browser path and dropped the imsc.all.* bundles, but the README still documents both. This updates the stale sections:

  • RUNTIME DEPENDENCIES: sax-js is no longer required. The section now explains that the native DOMParser is used by default, and that environments without it (for example Node.js) must pass fromXML() a parser that implements the contract in src/main/js/parser.js.
  • QUICK START: the build no longer produces build/public_html/libs/sax.js, so the example now loads only libs/imsc.js.
  • API: the fromXML() entry documents the optional parser argument added in 665e022.
  • BUILD: the artifact list drops imsc.all.debug.js and imsc.all.min.js and now matches what rollup and tsc produce: imsc.debug.js, imsc.min.js, and main/.

Written against the current integration/v2 tip (665e022). #265 also edits the README for the grunt removal; this PR keeps the current grunt wording and leaves the lines #265 touches unchanged.

🤖 Generated with Claude Code

Commit 665e022 removed sax from the browser path and dropped the
imsc.all.* bundles, but the README still documented both. Update the
RUNTIME DEPENDENCIES, QUICK START, API and BUILD sections to match:
the native DOMParser is used by default, a custom parser can be passed
to fromXML(), and dist contains imsc.debug.js, imsc.min.js and main/.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@palemieux
palemieux self-requested a review September 1, 2026 16:06
@palemieux
palemieux merged commit 6cd0ac7 into sandflow:integration/v2 Sep 1, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants