docs: spell out the two install paths in the README#10
Merged
Conversation
Add an Install section contrasting the two supported dependency setups: 1. zstd-platform — one empty jar, pulls everything, any OS/arch 2. zstd-bom + zstd + a cherry-picked zstd-native-<classifier> — leaner, single platform Lists the classifiers and points at the tutorial for Gradle / detail. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
What
The README only showed
zstd-platform. Add an Install section that contrasts both supported setups:zstd-platform— one empty jar, transitively pulls bindings + all six natives, runs on any OS/arch.zstd-bom+zstd+ onezstd-native-<classifier>— leaner, single platform; BOM pins versions.Lists the six classifiers and points at the tutorial for Gradle and detail (tutorial already documents both paths).
🤖 Generated with Claude Code