Repository navigation
docs: add v2 breaking changes and CONTRIBUTING.md - #100
Merged
Merged
Conversation
donskov
force-pushed
the
donskov/webcrypto-6-peers
branch
from
October 27, 2026 11:13
f25c33c to
7c50fc2
Compare
README: install requirements, a "Breaking Changes In v2" section (ESM-only and the Node.js range, TypeScript, Jest, deep imports, generated declarations, peer dependencies), an ESM usage example and a link to CONTRIBUTING.md. CONTRIBUTING.md is adapted from pvtsutils and webcrypto-core: project layout, checks, ESM-only packaging and generated exports, peers, sideEffects, and the release-please flow.
donskov
force-pushed
the
donskov/webcrypto-7-docs
branch
from
October 27, 2026 11:16
edaf6ea to
2207983
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stacked on #99 (part 7 of 7 for @peculiar/webcrypto 2.0.0; merge in order).
README: install requirements, "Breaking Changes In v2" (compact template: 3 packaging bullets + generated types + peers), ESM usage example, Contributing link. CONTRIBUTING.md adapted from pvtsutils/webcrypto-core. No AGENTS.md existed. Merge before the release PR so the npm README of 2.0.0 includes it.