Skip to content

Commit 6841ea7

Browse files
authored
Merge pull request #1 from ipld/feat/standardize-readme
Standardized Readme
2 parents ff11772 + e0731f5 commit 6841ea7

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,33 @@
11
# java-cid
22

33
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
4-
[![](https://img.shields.io/badge/project-ipld-blue.svg?style=flat-square)](http://github.com/ipld/ipld)
4+
[![](https://img.shields.io/badge/project-IPLD-blue.svg?style=flat-square)](http://github.com/ipld/ipld)
55
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
66

77
> A Java implementation of Content Id
88
99
This is the [cid](https://github.com/ipld/cid) implementation in Java.
1010

11+
## Table of Contents
12+
13+
- [Install](#install)
14+
- [Usage](#usage)
15+
- [Dependency](#dependency)
16+
- [Testing](#testing)
17+
- [Ant](#ant)
18+
- [Maven](#maven)
19+
- [Building](#building)
20+
- [Ant](#ant-1)
21+
- [Maven](#maven-1)
22+
- [Releasing](#releasing)
23+
- [Maintainers](#maintainers)
24+
- [Contribute](#contribute)
25+
- [License](#license)
26+
27+
## Install
28+
29+
Simply clone this repo.
30+
1131
## Usage
1232

1333
```
@@ -61,10 +81,10 @@ Captain: [@ianopolous](https://github.com/ianopolous).
6181

6282
Contributions welcome. Please check out [the issues](https://github.com/ipld/java-cid/issues).
6383

64-
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).
84+
Check out our [contributing document](https://github.com/ipld/ipld/blob/master/contributing.md) for more information on how we work, and about contributing in general. Please be aware that all interactions related to IPLD are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
6585

6686
Small note: If editing the Readme, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
6787

6888
## License
6989

70-
[MIT](LICENSE) © Ian Preston
90+
[MIT](LICENSE) © 2015 Ian Preston

0 commit comments

Comments
 (0)