Merge pull request #10 from paritytech/chore/add-readmes

Add readmes for parity-common crates
This commit is contained in:
Marek Kotewicz 2018-08-08 11:28:06 +02:00 committed by GitHub
commit 4de078b203
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 5 additions and 0 deletions

1
hashdb/README.md Normal file
View File

@ -0,0 +1 @@
`HashDB` defines a common interface for databases of byte-slices keyed to their hash. It is generic over hash type through the `Hasher` trait.

1
keccak-hash/README.md Normal file
View File

@ -0,0 +1 @@
`keccak-hash` is a set of utility functions to facilitate working with Keccak hashes (256/512 bits long).

1
memorydb/README.md Normal file
View File

@ -0,0 +1 @@
MemoryDB is a reference counted memory-based [`HashDB`](https://github.com/paritytech/parity-common/tree/master/hashdb) implementation backed by a `HashMap`.

2
triehash/README.md Normal file
View File

@ -0,0 +1,2 @@
This crate provides utility functions to validate and initialize tries using flexible input.
It is used extensively in `parity-ethereum` to validate blocks (mostly transactions and receipt roots).