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

docs: Make various README.md files consistent.

Browse source 
First, it removes the documentation section from all the README.md files
and instead puts a web-based godoc badge and link at the top with the
other badges.  This is being done since the local godoc tool no longer
ships with Go by default, so the instructions no longer work without
first installing godoc. Due to this, pretty much everyone uses the
web-based godoc these days anyways.  Anyone who has manually installed
godoc won't need instructions.

Second, it makes sure the ISC license badge is at the top with the other
badges and removes the textual reference in the overview section.

Finally, it's modifies the Installation section to Installation and
Updating and adds a '-u' to the 'go get' command since it works for both
and thus is simpler.
This commit is contained in:
Dave Collins 2015-10-23 11:34:50 -05:00
parent aa03d68e1e
commit 3942a116e4
8 changed files with 37 additions and 123 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
blockchain/README.md
View file

@ -4,6 +4,8 @@ blockchain
[![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)] [![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)]
(https://travis-ci.org/btcsuite/btcd) [![ISC License] (https://travis-ci.org/btcsuite/btcd) [![ISC License]
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org) (http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/blockchain)
Package blockchain implements bitcoin block handling and chain selection rules. Package blockchain implements bitcoin block handling and chain selection rules.
The test coverage is currently only around 60%, but will be increasing over The test coverage is currently only around 60%, but will be increasing over
@ -18,23 +20,10 @@ This package has intentionally been designed so it can be used as a standalone
package for any projects needing to handle processing of blocks into the bitcoin package for any projects needing to handle processing of blocks into the bitcoin
block chain. block chain.
## Documentation ## Installation and Updating
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/blockchain)
Full `go doc` style documentation for the project can be viewed online without
installing this package by using the GoDoc site here:
http://godoc.org/github.com/btcsuite/btcd/blockchain
You can also view the documentation locally once the package is installed with
the `godoc` tool by running `godoc -http=":6060"` and pointing your browser to
http://localhost:6060/pkg/github.com/btcsuite/btcd/blockchain
## Installation
```bash ```bash
$ go get github.com/btcsuite/btcd/blockchain $ go get -u github.com/btcsuite/btcd/blockchain
``` ```
## Bitcoin Chain Processing Overview ## Bitcoin Chain Processing Overview

22
btcec/README.md
View file

@ -2,7 +2,10 @@ btcec
===== =====
[![Build Status](https://travis-ci.org/btcsuite/btcd.png?branch=master)] [![Build Status](https://travis-ci.org/btcsuite/btcd.png?branch=master)]
(https://travis-ci.org/btcsuite/btcec) (https://travis-ci.org/btcsuite/btcec) [![ISC License]
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](https://godoc.org/github.com/btcsuite/btcd/btcec?status.png)]
(http://godoc.org/github.com/btcsuite/btcd/btcec)
Package btcec implements elliptic curve cryptography needed for working with Package btcec implements elliptic curve cryptography needed for working with
Bitcoin (secp256k1 only for now). It is designed so that it may be used with the Bitcoin (secp256k1 only for now). It is designed so that it may be used with the
@ -16,23 +19,10 @@ Although this package was primarily written for btcd, it has intentionally been
designed so it can be used as a standalone package for any projects needing to designed so it can be used as a standalone package for any projects needing to
use secp256k1 elliptic curve cryptography. use secp256k1 elliptic curve cryptography.
## Documentation ## Installation and Updating
[![GoDoc](https://godoc.org/github.com/btcsuite/btcd/btcec?status.png)]
(http://godoc.org/github.com/btcsuite/btcd/btcec)
Full `go doc` style documentation for the project can be viewed online without
installing this package by using the GoDoc site
[here](http://godoc.org/github.com/btcsuite/btcd/btcec).
You can also view the documentation locally once the package is installed with
the `godoc` tool by running `godoc -http=":6060"` and pointing your browser to
http://localhost:6060/pkg/github.com/btcsuite/btcd/btcec
## Installation
```bash ```bash
$ go get github.com/btcsuite/btcd/btcec $ go get -u github.com/btcsuite/btcd/btcec
``` ```
## Examples ## Examples

19
btcjson/README.md
View file

@ -4,6 +4,8 @@ btcjson
[![Build Status](https://travis-ci.org/btcsuite/btcd.png?branch=master)] [![Build Status](https://travis-ci.org/btcsuite/btcd.png?branch=master)]
(https://travis-ci.org/btcsuite/btcd) [![ISC License] (https://travis-ci.org/btcsuite/btcd) [![ISC License]
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org) (http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/btcjson)
Package btcjson implements concrete types for marshalling to and from the Package btcjson implements concrete types for marshalling to and from the
bitcoin JSON-RPC API. A comprehensive suite of tests is provided to ensure bitcoin JSON-RPC API. A comprehensive suite of tests is provided to ensure
@ -22,23 +24,10 @@ management, websocket support, automatic notification re-registration on
reconnect, and conversion from the raw underlying RPC types (strings, floats, reconnect, and conversion from the raw underlying RPC types (strings, floats,
ints, etc) to higher-level types with many nice and useful properties. ints, etc) to higher-level types with many nice and useful properties.
## Documentation ## Installation and Updating
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/btcjson)
Full `go doc` style documentation for the project can be viewed online without
installing this package by using the GoDoc site
[here](http://godoc.org/github.com/btcsuite/btcd/btcjson).
You can also view the documentation locally once the package is installed with
the `godoc` tool by running `godoc -http=":6060"` and pointing your browser to
http://localhost:6060/pkg/github.com/btcsuite/btcd/btcjson
## Installation
```bash ```bash
$ go get github.com/btcsuite/btcd/btcjson $ go get -u github.com/btcsuite/btcd/btcjson
``` ```
## Examples ## Examples

19
chaincfg/README.md
View file

@ -4,6 +4,8 @@ chaincfg
[![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)] [![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)]
(https://travis-ci.org/btcsuite/btcd) [![ISC License] (https://travis-ci.org/btcsuite/btcd) [![ISC License]
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org) (http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/chaincfg)
Package chaincfg defines chain configuration parameters for the three standard Package chaincfg defines chain configuration parameters for the three standard
Bitcoin networks and provides the ability for callers to define their own custom Bitcoin networks and provides the ability for callers to define their own custom
@ -53,23 +55,10 @@ func main() {
} }
``` ```
## Documentation ## Installation and Updating
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/chaincfg)
Full `go doc` style documentation for the project can be viewed online without
installing this package by using the GoDoc site
[here](http://godoc.org/github.com/btcsuite/btcd/chaincfg).
You can also view the documentation locally once the package is installed with
the `godoc` tool by running `godoc -http=":6060"` and pointing your browser to
http://localhost:6060/pkg/github.com/btcsuite/btcd/chaincfg
## Installation
```bash ```bash
$ go get github.com/btcsuite/btcd/chaincfg $ go get -u github.com/btcsuite/btcd/chaincfg
``` ```
## GPG Verification Key ## GPG Verification Key

19
database/README.md
View file

@ -4,6 +4,8 @@ database
[![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)] [![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)]
(https://travis-ci.org/btcsuite/btcd) [![ISC License] (https://travis-ci.org/btcsuite/btcd) [![ISC License]
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org) (http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/database)
Package database provides a database interface for the bitcoin block chain and Package database provides a database interface for the bitcoin block chain and
transactions. transactions.
@ -18,23 +20,10 @@ likely want to use the [btcrpcclient](https://github.com/btcsuite/btcrpcclient)
package which makes use of the [JSON-RPC API] package which makes use of the [JSON-RPC API]
(https://github.com/btcsuite/btcd/tree/master/docs/json_rpc_api.md). (https://github.com/btcsuite/btcd/tree/master/docs/json_rpc_api.md).
## Documentation ## Installation and Updating
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/database)
Full `go doc` style documentation for the project can be viewed online without
installing this package by using the GoDoc site
[here](http://godoc.org/github.com/btcsuite/btcd/database).
You can also view the documentation locally once the package is installed with
the `godoc` tool by running `godoc -http=":6060"` and pointing your browser to
http://localhost:6060/pkg/github.com/btcsuite/btcd/database
## Installation
```bash ```bash
$ go get github.com/btcsuite/btcd/database $ go get -u github.com/btcsuite/btcd/database
``` ```
## Examples ## Examples

15
peer/README.md
View file

@ -4,6 +4,8 @@ peer
[![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)] [![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)]
(https://travis-ci.org/btcsuite/btcd) [![ISC License] (https://travis-ci.org/btcsuite/btcd) [![ISC License]
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org) (http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/peer)
Package peer provides a common base for creating and managing bitcoin network Package peer provides a common base for creating and managing bitcoin network
peers. peers.
@ -55,19 +57,6 @@ A quick overview of the major features peer provides are as follows:
- Ability to wait for shutdown/disconnect - Ability to wait for shutdown/disconnect
- Comprehensive test coverage - Comprehensive test coverage
## Documentation
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/peer)
Full `go doc` style documentation for the project can be viewed online without
installing this package by using the GoDoc site here:
http://godoc.org/github.com/btcsuite/btcd/peer
You can also view the documentation locally once the package is installed with
the `godoc` tool by running `godoc -http=":6060"` and pointing your browser to
http://localhost:6060/pkg/github.com/btcsuite/btcd/peer
## Installation and Updating ## Installation and Updating
```bash ```bash

28
txscript/README.md
View file

@ -2,11 +2,13 @@ txscript
======== ========
[![Build Status](https://travis-ci.org/btcsuite/btcd.png?branch=master)] [![Build Status](https://travis-ci.org/btcsuite/btcd.png?branch=master)]
(https://travis-ci.org/btcsuite/btcd) (https://travis-ci.org/btcsuite/btcd) [![ISC License]
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](https://godoc.org/github.com/btcsuite/btcd/txscript?status.png)]
(http://godoc.org/github.com/btcsuite/btcd/txscript)
Package txscript implements the bitcoin transaction script language. There is Package txscript implements the bitcoin transaction script language. There is
a comprehensive test suite. Package txscript is licensed under the liberal ISC a comprehensive test suite.
license.
This package has intentionally been designed so it can be used as a standalone This package has intentionally been designed so it can be used as a standalone
package for any projects needing to use or validate bitcoin transaction scripts. package for any projects needing to use or validate bitcoin transaction scripts.
@ -18,23 +20,10 @@ the bitcoin transactions. This language is not turing complete
although it is still fairly powerful. A description of the language although it is still fairly powerful. A description of the language
can be found at https://en.bitcoin.it/wiki/Script can be found at https://en.bitcoin.it/wiki/Script
## Documentation ## Installation and Updating
[![GoDoc](https://godoc.org/github.com/btcsuite/btcd/txscript?status.png)]
(http://godoc.org/github.com/btcsuite/btcd/txscript)
Full `go doc` style documentation for the project can be viewed online without
installing this package by using the GoDoc site
[here](http://godoc.org/github.com/btcsuite/btcd/txscript).
You can also view the documentation locally once the package is installed with
the `godoc` tool by running `godoc -http=":6060"` and pointing your browser to
http://localhost:6060/pkg/github.com/btcsuite/btcd/txscript
## Installation
```bash ```bash
$ go get github.com/btcsuite/btcd/txscript $ go get -u github.com/btcsuite/btcd/txscript
``` ```
## Examples ## Examples
@ -75,4 +64,5 @@ verify the signature perform the following:
## License ## License
Package txscript is licensed under the liberal ISC License. Package txscript is licensed under the [copyfree](http://copyfree.org) ISC
License.

19
wire/README.md
View file

@ -4,6 +4,8 @@ wire
[![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)] [![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)]
(https://travis-ci.org/btcsuite/btcd) [![ISC License] (https://travis-ci.org/btcsuite/btcd) [![ISC License]
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org) (http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/wire)
Package wire implements the bitcoin wire protocol. A comprehensive suite of Package wire implements the bitcoin wire protocol. A comprehensive suite of
tests with 100% test coverage is provided to ensure proper functionality. tests with 100% test coverage is provided to ensure proper functionality.
@ -15,23 +17,10 @@ This package has intentionally been designed so it can be used as a standalone
package for any projects needing to interface with bitcoin peers at the wire package for any projects needing to interface with bitcoin peers at the wire
protocol level. protocol level.
## Documentation ## Installation and Updating
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/wire)
Full `go doc` style documentation for the project can be viewed online without
installing this package by using the GoDoc site here:
http://godoc.org/github.com/btcsuite/btcd/wire
You can also view the documentation locally once the package is installed with
the `godoc` tool by running `godoc -http=":6060"` and pointing your browser to
http://localhost:6060/pkg/github.com/btcsuite/btcd/wire
## Installation
```bash ```bash
$ go get github.com/btcsuite/btcd/wire $ go get -u github.com/btcsuite/btcd/wire
``` ```
## Bitcoin Message Overview ## Bitcoin Message Overview