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.
This commit is contained in:
Olaoluwa Osuntokun 2018-04-02 16:19:16 -07:00
parent b422e4ec1e
commit 000e77f36c
No known key found for this signature in database
GPG Key ID: 964EA263DD637C21
2 changed files with 6 additions and 6 deletions

View File

@ -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)
<img src="logo.png">
@ -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:

View File

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