Commit ad9db87c1c97950a008f8f2e0ea3d81cf300cf06
Update README.md
wanderer authored on 8/4/2017, 10:31:26 PMGitHub committed on 8/4/2017, 10:31:26 PM
Parent: 4143b5779d03c5527c674008885b39d94cfd76ec
Files changed
| README.md | changed |
| README.md | |||
|---|---|---|---|
| @@ -9,10 +9,12 @@ | |||
| 9 | 9 … | ||
| 10 | 10 … | # SYNOPSIS | |
| 11 | 11 … | This implements a binary merkle radix tree. The point of using a binary radix | |
| 12 | 12 … | tree is that it generates smaller proof size then trees with larger radixes. | |
| 13 | -This tree is well suited for storing large dictonaries of fairly random key. If | ||
| 13 … | +This tree is well suited for storing large dictonaries of fairly random keys. If | ||
| 14 | 14 … | the keys are not random better performance can be achived by hashing them first. | |
| 15 … | +It builds on top of [ipld-graph-builder](https://github.com/ipld/js-ipld-graph-builder) | ||
| 16 … | +and the resulting state and proofs are generated using it. | ||
| 15 | 17 … | ||
| 16 | 18 … | # INSTALL | |
| 17 | 19 … | `npm install merkle-radix-tree` | |
| 18 | 20 … | ||
| @@ -56,15 +58,15 @@ | |||
| 56 | 58 … | # API | |
| 57 | 59 … | ['./docs/'](./docs/index.md) | |
| 58 | 60 … | ||
| 59 | 61 … | # SPEC | |
| 60 | -['./docs/spec.md']('./docs/spec.md') | ||
| 62 … | +['./docs/spec.md'](./docs/spec.md) | ||
| 61 | 63 … | ||
| 62 | 64 … | # BENCHMARKS | |
| 63 | 65 … | The result of the benchmarks show that the binary radix tree produces proofs on | |
| 64 | -average %67 small then Ethereum Trie with 100000 keys stored. | ||
| 66 … | +average %67 small then the Ethereum Trie with 100000 keys stored. | ||
| 65 | 67 … | ||
| 66 | -['./benchmarks/benchmarks.md']('./docs/spec.md') | ||
| 68 … | +['./benchmarks/benchmarks.md']('./benchmarks/benchmarks.md') | ||
| 67 | 69 … | ||
| 68 | 70 … | # TESTS | |
| 69 | 71 … | `npm run tests` | |
| 70 | 72 … | ||
Built with git-ssb-web