LBRYCommunity/lbcd
1
0
Fork 0
Code Issues 17 Pull requests 4 Projects Releases 28 Packages Wiki Activity

docs: Update READMEs with current details.

Browse source 
This commit updates the main README.md and docs/README.md files to
replace the references to the now dead btcgui project with the
Windows-only Paymetheus project.

While here, it also updates some information to make it more current and
accurately describe the current status.
This commit is contained in:
Dave Collins 2016-03-11 14:36:32 -06:00
parent 5c59b685e6
commit 37938375dc
2 changed files with 12 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -7,9 +7,7 @@ btcd
btcd is an alternative full node bitcoin implementation written in Go (golang). btcd is an alternative full node bitcoin implementation written in Go (golang).
This project is currently under active development and is in a Beta state. It This project is currently under active development and is in a Beta state. It
is extremely stable and has been in production use for over 6 months as of May is extremely stable and has been in production use since October 2013.
2014, however there are still a couple of major features we want to add before
we come out of beta.
It properly downloads, validates, and serves the block chain using the exact It properly downloads, validates, and serves the block chain using the exact
rules (including bugs) for block acceptance as Bitcoin Core. We have taken rules (including bugs) for block acceptance as Bitcoin Core. We have taken
@ -30,8 +28,8 @@ blog entry [here](https://blog.conformal.com/btcd-not-your-moms-bitcoin-daemon)
for more details. This means you can't actually make or receive payments for more details. This means you can't actually make or receive payments
directly with btcd. That functionality is provided by the directly with btcd. That functionality is provided by the
[btcwallet](https://github.com/btcsuite/btcwallet) and [btcwallet](https://github.com/btcsuite/btcwallet) and
[btcgui](https://github.com/btcsuite/btcgui) projects which are both under [Paymetheus](https://github.com/btcsuite/Paymetheus) (Windows-only) projects
active development. which are both under active development.
## Requirements ## Requirements

18
docs/README.md
View file

@ -26,10 +26,8 @@
btcd is a full node bitcoin implementation written in [Go](http://golang.org), btcd is a full node bitcoin implementation written in [Go](http://golang.org),
licensed under the [copyfree](http://www.copyfree.org) ISC License. licensed under the [copyfree](http://www.copyfree.org) ISC License.
This project is currently under active development and is in a Beta state. It is This project is currently under active development and is in a Beta state. It
extremely stable and has been in production use for over 6 months as of May is extremely stable and has been in production use since October 2013.
2014, however there are still a couple of major features we want to add before
we come out of beta.
It currently properly downloads, validates, and serves the block chain using the It currently properly downloads, validates, and serves the block chain using the
exact rules (including bugs) for block acceptance as the reference exact rules (including bugs) for block acceptance as the reference
@ -45,14 +43,14 @@ required into the block chain and also includes the vast majority of the more
strict checks which filter transactions based on miner requirements ("standard" strict checks which filter transactions based on miner requirements ("standard"
transactions). transactions).
One key difference between btcd and bitcoind is that btcd does NOT include One key difference between btcd and Bitcoin Core is that btcd does *NOT* include
wallet functionality and this was a very intentional design decision. See the wallet functionality and this was a very intentional design decision. See the
[blog entry](https://blog.conformal.com/btcd-not-your-moms-bitcoin-daemon) for blog entry [here](https://blog.conformal.com/btcd-not-your-moms-bitcoin-daemon)
more details. This means you can't actually make or receive payments directly for more details. This means you can't actually make or receive payments
with btcd. That functionality is provided by the directly with btcd. That functionality is provided by the
[btcwallet](https://github.com/btcsuite/btcwallet) and [btcwallet](https://github.com/btcsuite/btcwallet) and
[btcgui](https://github.com/btcsuite/btcgui) projects which are both under [Paymetheus](https://github.com/btcsuite/Paymetheus) (Windows-only) projects
active development. which are both under active development.
<a name="GettingStarted" /> <a name="GettingStarted" />
### 2. Getting Started ### 2. Getting Started