diff --git a/README.md b/README.md index 1b93270..52908ed 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,16 @@ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) ![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg) + +# Docs +- [rlp](doc/rlp.md) +- [p2p](doc/p2p.md) +- [keys](doc/keys.md) +- [keyfile](doc/keyfile.md) +- [trie](doc/trie.md) +- [bloom](doc/bloom.md) + + ## License Licensed and distributed under either of diff --git a/doc/bloom.md b/doc/bloom.md index c840254..c3daa95 100644 --- a/doc/bloom.md +++ b/doc/bloom.md @@ -1,4 +1,4 @@ -# eth_bloom: an Ethereum Bloom Filter +# bloom: an Ethereum Bloom Filter # Introduction @@ -13,14 +13,9 @@ Ethereum bloom filters are implemented with the Keccak-256 cryptographic hash fu To see the bloom filter used in the context of Ethereum, please refer to the [Ethereum Yellow Paper](https://ethereum.github.io/yellowpaper/paper.pdf). -# Installation -``` -$ nimble install eth_bloom -``` - # Usage ```nim -import eth_bloom, stint +import eth/bloom, stint var f: BloomFilter f.incl("test1") assert("test1" in f) diff --git a/doc/keyfile.md b/doc/keyfile.md index 7146e0c..6d9dd40 100644 --- a/doc/keyfile.md +++ b/doc/keyfile.md @@ -1,4 +1,4 @@ -# eth_keyfile +# keyfile ## Introduction This library is a Nim reimplementation of [ethereum/eth-keyfile](https://github.com/ethereum/eth-keyfile), which is used to create and load Ethereum `keyfile` format and the tools for handling the format and for storing private keys. Currently, the library supports only the PBKDF2 method and does not support the Scrypt method. diff --git a/doc/keys.md b/doc/keys.md index 9c05194..9a85e5d 100644 --- a/doc/keys.md +++ b/doc/keys.md @@ -1,4 +1,4 @@ -# eth_keys +# keys This library is a Nim re-implementation of [eth-keys](https://github.com/ethereum/eth-keys): the common API for working with Ethereum's public and private keys, signatures, and addresses. diff --git a/doc/p2p.md b/doc/p2p.md index 61367c3..637f233 100644 --- a/doc/p2p.md +++ b/doc/p2p.md @@ -1,4 +1,4 @@ -# eth_p2p +# p2p ## Introduction diff --git a/doc/trie.md b/doc/trie.md index 686ab12..327f7ed 100644 --- a/doc/trie.md +++ b/doc/trie.md @@ -1,4 +1,4 @@ -# nim-trie +# trie Nim Implementation of the Ethereum Trie structure --- @@ -97,7 +97,7 @@ and then you want to continue/resume the trie operations. ```Nim import - eth_trie/[db, binary, utils] + eth/trie/[db, binary, utils] var db = newMemoryDB() var trie = initBinaryTrie(db) @@ -153,7 +153,7 @@ Therefore a list is enough to reconstruct the entire trie/branch. ```Nim import - eth_trie/[db, binary, utils] + eth/trie/[db, binary, utils] var db = newMemoryDB() var trie = initBinaryTrie(db) @@ -291,7 +291,7 @@ and then you want to continue/resume the trie operations. ```Nim import - eth_trie/[db, sparse_binary, utils] + eth/trie/[db, sparse_binary, utils] var db = newMemoryDB()