File tree Expand file tree Collapse file tree 1 file changed +34
-4
lines changed Expand file tree Collapse file tree 1 file changed +34
-4
lines changed Original file line number Diff line number Diff line change 1
1
# java-ipfs-api
2
- A Java implementation of the IPFS http api
3
2
4
- ##Usage
5
- -----
3
+ [ ![ ] ( https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square )] ( http://ipn.io )
4
+ [ ![ ] ( https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square )] ( http://ipfs.io/ )
5
+ [ ![ ] ( https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square )] ( http://webchat.freenode.net/?channels=%23ipfs )
6
+ [ ![ standard-readme compliant] ( https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square )] ( https://github.com/RichardLitt/standard-readme )
7
+
8
+ > A Java implementation of the IPFS http api
9
+
10
+ ## Table of Contents
11
+
12
+ - [ Install] ( #install )
13
+ - [ Usage] ( #usage )
14
+ - [ Building] ( #building )
15
+ - [ Contribute] ( #contribute )
16
+ - [ License] ( #license )
17
+
18
+ ## Install
19
+
20
+ Simply clone this repo.
21
+
22
+ ## Usage
23
+
6
24
Include the IPFS.jar in your project.
7
25
8
26
Create an IPFS instance with:
@@ -33,8 +51,20 @@ Multihash filePointer = Multihash.fromBase58("QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ew
33
51
byte [] fileContents = ipfs. cat(filePointer);
34
52
```
35
53
36
- ##Building
54
+ ## Building
37
55
---------
38
56
To build just run make. There are no dependencies, just include the resulting IPFS.jar in your project.
39
57
40
58
To run tests use make tests.
59
+
60
+ ## Contribute
61
+
62
+ Feel free to join in. All welcome. Open an [ issue] ( https://github.com/ipfs/java-ipfs-api/issues ) !
63
+
64
+ This repository falls under the IPFS [ Code of Conduct] ( https://github.com/ipfs/community/blob/master/code-of-conduct.md ) .
65
+
66
+ [ ![ ] ( https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif )] ( https://github.com/ipfs/community/blob/master/contributing.md )
67
+
68
+ ## License
69
+
70
+ [ MIT] ( LICENSE )
You can’t perform that action at this time.
0 commit comments