Skip to content

Commit 93eed1a

Browse files
authored
Merge pull request #1 from multiformats/feature/standardize-readme
Add README and MIT License
2 parents 1a2af7f + 3b181a2 commit 93eed1a

1 file changed

Lines changed: 28 additions & 1 deletion

File tree

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,35 @@
11
# java-multihash
2-
A Java implementation of Multihash
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+
> A Java implementation of Multihash
8+
9+
This is the [multihash](https://github.com/multiformats/multihash) implementation in Java.
310

411
## Usage
12+
13+
```
514
Multihash m = Multihash.fromBase58("QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy");
15+
```
616

717
## Compilation
18+
819
To compile just run ant.
20+
21+
## Maintainers
22+
23+
Captain: [@ianopolous](https://github.com/ianopolous).
24+
25+
## Contribute
26+
27+
Contributions welcome. Please check out [the issues](https://github.com/multiformats/java-multihash/issues).
28+
29+
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).
30+
31+
Small note: If editing the Readme, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
32+
33+
## License
34+
35+
[MIT](LICENSE) © Ian Preston

0 commit comments

Comments
 (0)