docs: rewrite README for ESM v2 + scope npm package to src/#26
Merged
Conversation
- README: ESM usage (import), drop dead Travis/Scrutinizer badges, document v2 breaking change + Node >=18 requirement. - package.json: add files: ["src"] so the published tarball ships only the source (excludes test/, .github/, eslint config).
pocketrocket
force-pushed
the
chore/release-2.0.0-prep
branch
from
a206bc2 to
50c150a
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
1 participant
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.
Release prep for the v2.0.0 (ESM) major.
import floatify from "floatify"), documents the v2 breaking change and Node ≥ 18 requirement, and drops the dead Travis / Scrutinizer badges.files: ["src"]so the published npm tarball ships only the source. Before this,npm packincludedtest/(17 kB),.github/and the eslint config; now the tarball is justsrc/,README.md,LICENSE,package.json.npm pack --dry-run→ 4 files.node --test→ 281 passing.