docs: Clarify supported Target Java Version on README (re. #242) #263
Conversation
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR clarifies the supported target Java version in the README documentation, addressing issue #242. The changes improve documentation clarity and formatting throughout the README.
Changes:
- Added explicit Java 11 runtime requirement documentation
- Improved formatting with proper code block syntax highlighting and spacing
- Fixed capitalization of "HTTP API" for consistency
- Reorganized the "Running tests" section for better clarity
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
README.md
Outdated
| * [multihash](https://github.com/multiformats/java-multihash) | ||
| * [cid](https://github.com/ipld/java-cid) | ||
|
|
||
| This library requires (only) Java 11 bytecode & JDK at runtime. (At build time we use current latest LTS tools.) |
There was a problem hiding this comment.
The word "(only)" in parentheses seems out of place and unclear. It's not evident what aspect is being emphasized as "only" - is it "only Java 11" (not higher), "only at runtime" (not build time), or something else? Consider removing this word or clarifying the intended meaning.
Suggested change
| This library requires (only) Java 11 bytecode & JDK at runtime. (At build time we use current latest LTS tools.) | |
| This library requires Java 11 bytecode & JDK at runtime. (At build time we use current latest LTS tools.) |
Collaborator
Author
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
cstamas
approved these changes
Jan 20, 2026
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.
Re. #242.