From 95888613d02a7201ee9160272f8a20bd45bb4da5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christopher=20J=C3=A4mthagen?= Date: Wed, 11 Jan 2017 18:36:02 +0100 Subject: [PATCH] multi: minor fixes for README's --- chainntnfs/README.md | 4 ++-- channeldb/README.md | 2 +- lnrpc/README.md | 6 +++--- lnwallet/README.md | 2 +- lnwire/README.md | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/chainntnfs/README.md b/chainntnfs/README.md index 5b8493169..639f69c95 100644 --- a/chainntnfs/README.md +++ b/chainntnfs/README.md @@ -7,7 +7,7 @@ chainntnfs [![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)] (http://godoc.org/github.com/lightningnetwork/lnd/chainntnfs) -The chainntnfs package implements as set of interfaces which allow callers to +The chainntnfs package implements a set of interfaces which allow callers to receive notifications in response to specific on-chain events. The set of notifications available include: @@ -22,7 +22,7 @@ closures, channel contract breaches, sweeping time-locked outputs, and finally pruning the channel graph. This package is intentionally general enough to be applicable outside the -specific use cases within `lnd` outline above. The current sole concrete +specific use cases within `lnd` outlined above. The current sole concrete implementation of the `ChainNotifier` interface depends on `btcd`. ## Installation and Updating diff --git a/channeldb/README.md b/channeldb/README.md index 314da9e97..b1f8c4c59 100644 --- a/channeldb/README.md +++ b/channeldb/README.md @@ -10,7 +10,7 @@ channeldb The channeldb implements the persistent storage engine for `lnd` and generically a data storage layer for the required state within the Lightning Network. The backing storage engine is -[boltdb](https://github.com/boltdb/bolt), an embedded pure-go key-value stored +[boltdb](https://github.com/boltdb/bolt), an embedded pure-go key-value store based off of LMDB. The package implements an object-oriented storage model with queries and diff --git a/lnrpc/README.md b/lnrpc/README.md index 0b42ba8c7..374126669 100644 --- a/lnrpc/README.md +++ b/lnrpc/README.md @@ -28,7 +28,7 @@ description): * Returns a list of on-chain transactions that pay to or are spends from `lnd`. * SendCoins - * Sends an amount of satoshis to a specific addresses. + * Sends an amount of satoshis to a specific address. * SubscribeTransactions * Returns a stream which sends async notifications each time a transaction is created or one is received that pays to us. @@ -36,7 +36,7 @@ description): * Allows the caller to create a transaction with an arbitrary fan-out (many outputs). * NewAddress - * Returns a new addresses, the following address types are supported: + * Returns a new address, the following address types are supported: pay-to-public-key-hash (p2pkh), pay-to-witness-key-hash (p2wkh), and nested-pay-to-witness-key-hash (np2wkh). * ConnectPeer @@ -80,7 +80,7 @@ description): * GetNetworkInfo * Returns some network level statistics. * SetAlias - * Sets the node alias whchi is to be advertised on the network. + * Sets the node alias which is to be advertised on the network. ## Installation and Updating diff --git a/lnwallet/README.md b/lnwallet/README.md index 9aecd4ec4..c3cc14042 100644 --- a/lnwallet/README.md +++ b/lnwallet/README.md @@ -13,7 +13,7 @@ generation functions for the various Lightning scripts, revocation key derivation, and the commitment update state machine. The package is used within `lnd` as the core wallet of the daemon. The wallet -itself is composed of several distinct interface that decouple the +itself is composed of several distinct interfaces that decouple the implementation of things like signing and blockchain access. This separation allows new `WalletController` implementations to be be easily dropped into `lnd` without disrupting the code base. A series of integration tests at the diff --git a/lnwire/README.md b/lnwire/README.md index 3e8feb5ef..c11a3a961 100644 --- a/lnwire/README.md +++ b/lnwire/README.md @@ -10,7 +10,7 @@ lnwire The lnwire package implements the Lightning Network wire protocol. This package has intentionally been designed so it can be used as a standalone -package for any projects needing to interface with lighting peers at the wire +package for any projects needing to interface with lightning peers at the wire protocol level. ## Installation and Updating