From e6c9fddbaf50ee9f79ba41e893ea04903bce6c21 Mon Sep 17 00:00:00 2001 From: Dave Collins Date: Tue, 19 Mar 2019 02:18:24 -0500 Subject: [PATCH] hdkeychain: Update README.md. This updates the README.md in hdkeychain to account for changes made in Decred, correct the NewMaster godoc example link, and format the examples so the description is on the line after the link for consistency with other packages in the code base. --- hdkeychain/README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/hdkeychain/README.md b/hdkeychain/README.md index 880690a4..e90d4e27 100644 --- a/hdkeychain/README.md +++ b/hdkeychain/README.md @@ -24,13 +24,13 @@ report. keys - Support for custom networks by registering them with chaincfg - Obtaining the underlying EC pubkeys, EC privkeys, and associated decred - addresses ties in seamlessly with existing btcec and dcrutil types which + addresses ties in seamlessly with existing secp256k1 and dcrutil types which provide powerful tools for working with them to do things like sign transactions and generate payment scripts -- Uses the btcec package which is highly optimized for secp256k1 +- Uses the highly-optimized secp256k1 package - Code examples including: - - Generating a cryptographically secure random seed and deriving a - master node from it + - Generating a cryptographically secure random seed and deriving a master node + from it - Default HD wallet layout as described by BIP0032 - Audits use case as described by BIP0032 - Comprehensive test coverage including the BIP0032 test vectors @@ -44,13 +44,13 @@ $ go get -u github.com/decred/dcrd/hdkeychain ## Examples -* [NewMaster Example](http://godoc.org/github.com/decred/dcrd/hdkeychain#example-NewMaster) +* [NewMaster Example](http://godoc.org/github.com/decred/dcrd/hdkeychain#example-package--NewMaster) Demonstrates how to generate a cryptographically random seed then use it to create a new master node (extended key). -* [Default Wallet Layout Example](http://godoc.org/github.com/decred/dcrd/hdkeychain#example-package--DefaultWalletLayout) +* [Default Wallet Layout Example](http://godoc.org/github.com/decred/dcrd/hdkeychain#example-package--DefaultWalletLayout) Demonstrates the default hierarchical deterministic wallet layout as described in BIP0032. -* [Audits Use Case Example](http://godoc.org/github.com/decred/dcrd/hdkeychain#example-package--Audits) +* [Audits Use Case Example](http://godoc.org/github.com/decred/dcrd/hdkeychain#example-package--Audits) Demonstrates the audits use case in BIP0032. ## License