Skip to content

Commit 30d4ccf

Browse files
committed
update README
1 parent e4cf8a0 commit 30d4ccf

1 file changed

Lines changed: 62 additions & 3 deletions

File tree

README.md

Lines changed: 62 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# java-multibase
2-
A Java implementation of Multibase
2+
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-multiformats-blue.svg?style=flat-square)](http://github.com/multiformats/multiformats)
5+
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
6+
7+
8+
A Java implementation of [Multibase](https://github.com/multiformats/multibase)
39

410
## Usage
511
```java
@@ -8,5 +14,58 @@ String encoded = Multibase.encode(Multibase.Base.Base58BTC, data);
814
byte[] decoded = Multibase.decode(encoded);
915
```
1016

11-
## Compilation
12-
To compile just run ant.
17+
## Dependency
18+
You can use this project by building the JAR file as specified below, or by using [JitPack](https://jitpack.io/#multiformats/java-multibase/) (also supporting Gradle, SBT, etc).
19+
20+
for Maven, you can add the follwing sections to your POM.XML:
21+
```
22+
<repositories>
23+
<repository>
24+
<id>jitpack.io</id>
25+
<url>https://jitpack.io</url>
26+
</repository>
27+
</repositories>
28+
29+
<dependencies>
30+
<dependency>
31+
<groupId>com.github.multiformats</groupId>
32+
<artifactId>java-multibase</artifactId>
33+
<version>v1.0.0</version>
34+
</dependency>
35+
</dependencies>
36+
```
37+
38+
## Testing
39+
40+
### Ant
41+
`ant test`
42+
43+
### Maven
44+
`mvn test`
45+
46+
## Building
47+
48+
### Ant
49+
`ant dist` will build a JAR file in the `./dist` suitable for manual inclusion in a project. Dependent libraries are included in `./dist/lib`.
50+
51+
### Maven
52+
`mvn package` will build a JAR file with Maven dependency information.
53+
54+
## Releasing
55+
The version number is specified in `build.xml` and `pom.xml` and must be changed in both places 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 to work.
56+
57+
## Maintainers
58+
59+
Captain: [@ianopolous](https://github.com/ianopolous).
60+
61+
## Contribute
62+
63+
Contributions welcome. Please check out [the issues](https://github.com/multiformats/java-multibase/issues).
64+
65+
Check out our [contributing document](https://github.com/multiformats/multiformats/blob/master/contributing.md) for more information on how we work, and about contributing in general. Please be aware that all interactions related to multiformats are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
66+
67+
Small note: If editing the Readme, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
68+
69+
## License
70+
71+
[MIT](LICENSE) © Ian Preston

0 commit comments

Comments
 (0)