Skip to content

Commit 7ae46dd

Browse files
authored
Cleaned up readme a bit (#33)
* Cleaned up readme a bit Related to #8 * Fixed github tagline * Changed link to be more accurate and readable * Fixed spelling error, added MIT License file * Fix markdown issue with interword italics
1 parent 4ed1061 commit 7ae46dd

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
11
# multihash
22

3+
<<<<<<< HEAD
34
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
45
[![](https://img.shields.io/badge/project-multiformats-blue.svg?style=flat-square)](https://github.com/multiformats/multiformats)
56
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](https://webchat.freenode.net/?channels=%23ipfs)
67
[![](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
78

9+
=======
10+
>>>>>>> Fixed github tagline
811
> Self identifying hashes
912
1013
Multihash is a protocol for differentiating outputs from various well-established cryptographic hash functions, addressing size + encoding considerations.
1114

12-
It is useful to write applications that future-proof their use of hashes, and allow multiple hash functions to coexist. See https://github.com/jbenet/random-ideas/issues/1 for a longer discussion.
15+
It is useful to write applications that future-proof their use of hashes, and allow multiple hash functions to coexist. See [jbenet/random-ideas#1](https://github.com/jbenet/random-ideas/issues/1) for a longer discussion.
1316

1417
## Table of Contents
1518

16-
- [Table of Contents](#table-of-contents)
1719
- [Example](#example)
1820
- [Format](#format)
1921
- [Implementations:](#implementations)
2022
- [Table for Multihash v1.0.0-RC (semver)](#table-for-multihash-v100-rc-semver)
21-
- [Other tables](#other-tables)
23+
- [Other Tables](#other-tables)
2224
- [Disclaimers](#disclaimers)
2325
- [Visual Examples](#visual-examples)
2426
- [Maintainers](#maintainers)
@@ -120,8 +122,7 @@ code name
120122
# 0x14 formerly had the name "sha3", now deprecated
121123
```
122124

123-
124-
### Other tables
125+
### Other Tables
125126

126127
Cannot find a good standard on this. Found some _different_ IANA ones:
127128

@@ -132,6 +133,7 @@ They disagree. :(
132133

133134
## Disclaimers
134135

136+
<<<<<<< HEAD
135137
Warning: **obviously multihash values bias the first two bytes**. Do not expect them to be uniformly distributed. The entropy size is `len(multihash) - 2`. Skip the first two bytes when using them with bloom filters, etc. Why not _ap_pend instead of _pre_pend? Because when reading a stream of hashes, you can know the length of the whole value, and allocate the right amount of memory, skip it, or discard it.
136138

137139
## Visual Examples
@@ -171,6 +173,9 @@ These are visual aids that help tell the story of why Multihash matters.
171173
## Maintainers
172174

173175
Captain: [@jbenet](https://github.com/jbenet).
176+
=======
177+
Warning: **obviously multihash values bias the first two bytes**. Do not expect them to be uniformly distributed. The entropy size is `len(multihash) - 2`. Skip the first two bytes when using them with bloom filters, etc. Why not _ap_-pend instead of _pre_-pend? Because when reading a stream of hashes, you can know the length of the hash (from the table).
178+
>>>>>>> Fix markdown issue with interword italics
174179
175180
## Contribute
176181

@@ -182,5 +187,8 @@ Small note: If editing the README, please conform to the [standard-readme](https
182187

183188
## License
184189

190+
<<<<<<< HEAD
185191
This repository is only for documents. All of these are licensed under the [CC-BY-SA 3.0](https://ipfs.io/ipfs/QmVreNvKsQmQZ83T86cWSjPu2vR3yZHGPm5jnxFuunEB9u) license © 2016 Protocol Labs Inc. Any code is under a [MIT](LICENSE) © 2016 Protocol Labs Inc.
186-
192+
=======
193+
[MIT](LICENSE).
194+
>>>>>>> Fixed spelling error, added MIT License file

0 commit comments

Comments
 (0)