Skip to content

docs: Clarify supported Target Java Version on README (re. #242) #263

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vorburger wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: Clarify supported Target Java Version on README (re. #242) #263

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e526db
docs: Clarify supported Target Java Version on README (re. #242)
vorburger Jan 20, 2026
c8ba264
Update README.md
vorburger Jan 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

![](https://ipfs.io/ipfs/QmQJ68PFMDdAsgCZvA1UVzzn18asVcf7HVvCDgpjiSCAse)

> A Java client for the IPFS http api
> A Java client for the IPFS HTTP API

## Table of Contents

Expand All @@ -28,7 +28,8 @@ You can use this project by including `ipfs.jar` from one of the [releases](http
Package managers are supported through [JitPack](https://jitpack.io/#ipfs/java-ipfs-http-client/) which supports Maven, Gradle, SBT, etc.

for Maven, add the following sections to your pom.xml (replacing $LATEST_VERSION):
```

```xml
<repositories>
<repository>
<id>jitpack.io</id>
Expand All @@ -49,13 +50,14 @@ for Maven, add the following sections to your pom.xml (replacing $LATEST_VERSION

* Clone this repository
* Run `mvn install`
* Copy `target/ipfs-$VERSION.jar` into your project. Appropriate versions of other [dependencies](#dependencies) are also included in `dist/lib/`.
* Copy `target/ipfs-$VERSION.jar` into your project.
* To copy the project and all dependency JARs to directory, execute `mvn eu.maveniverse.maven.plugins:toolbox:gav-copy -DsourceSpec="resolveTransitive(gav(com.github.ipfs:java-ipfs-http-client:v1.4.5-SNAPSHOT))" -DsinkSpec="flat(.)"` in that given directory.
* Run tests using `mvn test` (invocation above will run them as well).

### Running tests

To run tests, IPFS daemon must be running on the `127.0.0.1` interface, with `--enable-pubsub-experiment`.
Run tests using `mvn test`.

To run tests, an IPFS daemon must be running on the `127.0.0.1` interface, with `--enable-pubsub-experiment`.

### IPFS installation

Expand Down Expand Up @@ -108,7 +110,10 @@ Current versions of dependencies are listed in the `pom.xml`, their correspondin
* [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.)
Comment thread
vorburger marked this conversation as resolved.
Outdated
Copy link

Copilot AI Jan 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.)

Copilot uses AI. Check for mistakes.

## Releasing

The version number is specified in `pom.xml` and must be changed in order to be accurately reflected in the JAR file manifest. A git tag must be added in the format `vx.x.x` for [JitPack](https://jitpack.io/#ipfs/java-ipfs-http-client/) to work.

## Contribute
Expand Down