document more things

tendermint · Jun 12, 2018 · 0e710fb · 0e710fb
1 parent 54b9bd5
commit 0e710fb
Showing 1 changed file with 11 additions and 3 deletions.
diff --git a/keys/hd/hdpath.go b/keys/hd/hdpath.go
@@ -1,6 +1,14 @@
-// Package hd provides bip44 / bip 32 functionality.
-// - bip 32 paths work too
-// TODO(ismail): proper documentation
+// Package hd provides basic functionality Hierarchical Deterministic Wallets.
+//
+// The user must understand the overall concept of the BIP 32 and the BIP 44 specs:
+//  - https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki
+//  - https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki
+//
+// In combination with the bip39 package in go-crypto this package provides the functionality for deriving keys using a
+// BIP 44 HD path, or, more general, by passing a BIP 32 path.
+//
+// In particular, this package (together with bip39) provides all necessary functionality to derive keys from
+// mnemonics generated during the cosmos fundraiser.
 package hd
 
 import (