Skip to content

Commit 96335a7

Browse files
authored
Merge pull request #38 from celeduc/depmgmt
Version 1.1.1 for maven support
2 parents c7d62eb + c6fc99e commit 96335a7

File tree

6 files changed

+48
-12
lines changed

6 files changed

+48
-12
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
dist/*
44
target/
55
dependency-reduced-pom.xml
6+
TEST-io.ipfs.api.APITest.*
67

78
# Scala-IDE specific
89
.idea/*

.travis.yml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
language: java
2+
jdk:
3+
- oraclejdk8
4+
before_script:
5+
- wget https://dist.ipfs.io/go-ipfs/v0.4.10/go-ipfs_v0.4.10_linux-amd64.tar.gz -O /tmp/go-ipfs_v0.4.10_linux-amd64.tar.gz
6+
- tar -xvf /tmp/go-ipfs_v0.4.10_linux-amd64.tar.gz
7+
- export PATH=$PATH:$PWD/go-ipfs/
8+
- ipfs init
9+
- ipfs daemon --enable-pubsub-experiment &

README.md

+35-9
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,40 @@
1919

2020
## Install
2121

22-
Simply clone this repo.
22+
### Official releases
2323

24-
## Usage
24+
You can use this project by including `ipfs.jar` from one of the [releases](https://github.com/ipfs/java-ipfs-api/releases).
25+
26+
### Maven, Gradle, SBT
27+
28+
Package managers are supported through [JitPack](https://jitpack.io/#ipfs/java-ipfs-api/) whcih supports Maven, Gradle, SBT, etc.
29+
30+
for Maven, add the following sections to your pom.xml:
31+
```
32+
<repositories>
33+
<repository>
34+
<id>jitpack.io</id>
35+
<url>https://jitpack.io</url>
36+
</repository>
37+
</repositories>
38+
39+
<dependencies>
40+
<dependency>
41+
<groupId>com.github.ipfs</groupId>
42+
<artifactId>java-ipfs-api</artifactId>
43+
<version>v1.1.1</version>
44+
</dependency>
45+
</dependencies>
46+
```
47+
48+
### Building
2549

26-
Include the IPFS.jar in your project.
50+
* Clone this repository
51+
* Run `ant dist`
52+
* Copy `dist/ipfs.jar` into your project. Appropriate versions of other [dependencies](#Dependencies) are also included in `dist/lib/`.
53+
* Run tests using `ant test`.
54+
55+
## Usage
2756

2857
Create an IPFS instance with:
2958
```Java
@@ -54,17 +83,14 @@ byte[] fileContents = ipfs.cat(filePointer);
5483
```
5584

5685
## Dependencies
86+
87+
Current versions of dependencies are included in the `./lib` directory.
88+
5789
* [multibase](https://github.com/multiformats/java-multibase)
5890
* [multiaddr](https://github.com/multiformats/java-multiaddr)
5991
* [multihash](https://github.com/multiformats/java-multihash)
6092
* [cid](https://github.com/ipld/java-cid)
6193

62-
## Building
63-
---------
64-
To build just run `ant dist`. The dependencies are included in the `./lib` directory, and automatically copied to the `./dist/lib` directory.
65-
66-
To run tests use `ant test`.
67-
6894
## Contribute
6995

7096
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/java-ipfs-api/issues)!

build.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
<attribute name="Class-Path" value="${manifest_cp}"/>
4141
<attribute name="Implementation-Vendor" value="io.ipfs"/>
4242
<attribute name="Implementation-Title" value="api"/>
43-
<attribute name="Implementation-Version" value="1.1.0"/>
43+
<attribute name="Implementation-Version" value="1.1.1"/>
4444
</manifest>
4545
</jar>
4646
</target>

lib/multiaddr.jar

-3.15 KB
Binary file not shown.

pom.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<groupId>io.ipfs</groupId>
66
<artifactId>api</artifactId>
7-
<version>v1.1.0</version>
7+
<version>v1.1.1</version>
88
<packaging>jar</packaging>
99

1010
<name>java-ipfs-api</name>
@@ -59,7 +59,7 @@
5959
<dependency>
6060
<groupId>com.github.multiformats</groupId>
6161
<artifactId>java-multiaddr</artifactId>
62-
<version>v1.0.0</version>
62+
<version>v1.1.1</version>
6363
</dependency>
6464
<dependency>
6565
<groupId>com.github.multiformats</groupId>

0 commit comments

Comments
 (0)