Skip to content

Commit 4c7c412

Browse files
authored
Merge pull request #36 from vorburger/document-encodings
Document which encodings & decodings are built-in on README
2 parents 47cf47a + 3d67a3f commit 4c7c412

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,26 @@
55
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](https://webchat.freenode.net/?channels=%23ipfs)
66
[![](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
77

8-
> A Java implementation of [Multibase](https://github.com/multiformats/multibase)
8+
> A Java implementation of [Multibase](https://github.com/multiformats/multibase) with encoding & decoding support for: base16[upper], base32[hex][pad][upper], base36[upper], base58btc, base64[url][pad], [base256emoji](https://github.com/multiformats/java-multibase/issues/35).
99
1010
## Install
1111

1212
Simply clone this repo.
1313

1414
## Usage
15+
1516
```java
1617
byte[] data = ...
1718
String encoded = Multibase.encode(Multibase.Base.Base58BTC, data);
1819
byte[] decoded = Multibase.decode(encoded);
1920
```
2021

2122
## Dependency
23+
2224
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).
2325

2426
for Maven, you can add the follwing sections to your POM.XML:
27+
2528
```xml
2629
<repositories>
2730
<repository>

0 commit comments

Comments
 (0)