From 000e77f36c893bec457f9b7bbc02011f43a65eda Mon Sep 17 00:00:00 2001 From: Olaoluwa Osuntokun Date: Mon, 2 Apr 2018 16:19:16 -0700 Subject: [PATCH] docs+README: update docs to no longer imply that only btcd is support In this commit, we modify the docs in order to clarify that both btcd and bitcoind are supported as chain backends. Many users expressed confusion as the old set of docs stated that we "require" my btcd fork, rather than clarifying that *if* you want to use btcd, then you must use my fork. --- README.md | 5 ++--- docs/INSTALL.md | 7 ++++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index fc82fe24..f36fb9e3 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/lightningnetwork/lnd/blob/master/LICENSE) [![Irc](https://img.shields.io/badge/chat-on%20freenode-brightgreen.svg)](https://webchat.freenode.net/?channels=lnd) [![Godoc](https://godoc.org/github.com/lightningnetwork/lnd?status.svg)](https://godoc.org/github.com/lightningnetwork/lnd) -[![Coverage Status](https://coveralls.io/repos/github/lightningnetwork/lnd/badge.svg?branch=master)](https://coveralls.io/github/lightningnetwork/lnd?branch=master) @@ -12,8 +11,8 @@ The Lightning Network Daemon (`lnd`) - is a complete implementation of a [Lightning Network](https://lightning.network) node and currently deployed on `testnet3` - the Bitcoin Test Network. `lnd` has several pluggable back-end chain services including [`btcd`](https://github.com/btcsuite/btcd) (a -full-node) and [`neutrino`](https://github.com/lightninglabs/neutrino) (a new -experimental light client). The project's codebase uses the +full-node), [`bitcoind`](https://github.com/bitcoin/bitcoin), and +[`neutrino`](https://github.com/lightninglabs/neutrino) (a new experimental light client). The project's codebase uses the [btcsuite](https://github.com/btcsuite/) set of Bitcoin libraries, and also exports a large set of isolated re-usable Lightning Network related libraries within it. In the current state `lnd` is capable of: diff --git a/docs/INSTALL.md b/docs/INSTALL.md index 98977f8e..35120d7c 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -79,9 +79,10 @@ make check ### Installing btcd -`lnd` currently requires the [roasbeef](https://github.com/roasbeef/btcd) fork -of `btcd` due to neutrino additions that are not yet available in the master -branch. To install, run the following commands: +When using the `btcd` backend, `lnd` currently requires the +[roasbeef](https://github.com/roasbeef/btcd) fork of `btcd` due to neutrino +additions that are not yet available in the master branch. To install, run the +following commands: Install **btcd**: (must be from roasbeef fork, not from btcsuite) ```