Minor doc fixes

This commit is contained in:
Yuriy Glukhov 2019-02-06 11:15:03 +01:00
parent db6d7888c7
commit 0bc80d73cd
6 changed files with 19 additions and 14 deletions

View File

@ -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

View File

@ -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)

View File

@ -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.

View File

@ -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.

View File

@ -1,4 +1,4 @@
# eth_p2p
# p2p
## Introduction

View File

@ -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()