LBRYCommunity/lbcutil
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 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.

Third, 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.

Finally, it replaces the badges with SVG versions from shields.io so
they are consistent.
This commit is contained in:
Dave Collins 2015-10-23 17:10:35 -05:00
parent d6989ebc71
commit e8bab6bc19
6 changed files with 42 additions and 104 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -1,16 +1,19 @@
btcutil btcutil
======= =======
[![Build Status](https://travis-ci.org/btcsuite/btcutil.png?branch=master)] [![Build Status](http://img.shields.io/travis/btcsuite/btcutil.svg)]
(https://travis-ci.org/btcsuite/btcutil) [![Coverage Status] (https://travis-ci.org/btcsuite/btcutil) [![Coverage Status]
(https://coveralls.io/repos/btcsuite/btcutil/badge.png?branch=master)] (http://img.shields.io/coveralls/btcsuite/btcutil.svg)]
(https://coveralls.io/r/btcsuite/btcutil?branch=master) (https://coveralls.io/r/btcsuite/btcutil?branch=master) [![ISC License]
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](http://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcutil)
Package btcutil provides bitcoin-specific convenience functions and types. Package btcutil provides bitcoin-specific convenience functions and types.
A comprehensive suite of tests is provided to ensure proper functionality. See A comprehensive suite of tests is provided to ensure proper functionality. See
`test_coverage.txt` for the gocov coverage report. Alternatively, if you are `test_coverage.txt` for the gocov coverage report. Alternatively, if you are
running a POSIX OS, you can run the `cov_report.sh` script for a real-time running a POSIX OS, you can run the `cov_report.sh` script for a real-time
report. Package btcutil is licensed under the liberal ISC license. report.
This package was developed for btcd, an alternative full-node implementation of This package was developed for btcd, an alternative full-node implementation of
bitcoin which is under active development by Conformal. Although it was bitcoin which is under active development by Conformal. Although it was
@ -18,23 +21,10 @@ primarily written for btcd, this package has intentionally been designed so it
can be used as a standalone package for any projects needing the functionality can be used as a standalone package for any projects needing the functionality
provided. provided.
## Documentation ## Installation and Updating
[![GoDoc](https://godoc.org/github.com/btcsuite/btcutil?status.png)]
(http://godoc.org/github.com/btcsuite/btcutil)
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/btcutil
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/btcutil
## Installation
```bash ```bash
$ go get github.com/btcsuite/btcutil $ go get -u github.com/btcsuite/btcutil
``` ```
## GPG Verification Key ## GPG Verification Key

25
base58/README.md
View file

@ -1,33 +1,22 @@
base58 base58
========== ==========
[![Build Status](https://travis-ci.org/btcsuite/btcutil.png?branch=master)] [![Build Status](http://img.shields.io/travis/btcsuite/btcutil.svg)]
(https://travis-ci.org/btcsuite/btcutil) (https://travis-ci.org/btcsuite/btcutil) [![ISC License]
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](https://godoc.org/github.com/btcsuite/btcutil/base58?status.png)]
(http://godoc.org/github.com/btcsuite/btcutil/base58)
Package base58 provides an API for encoding and decoding to and from the Package base58 provides an API for encoding and decoding to and from the
modified base58 encoding. It also provides an API to do Base58Check encoding, modified base58 encoding. It also provides an API to do Base58Check encoding,
as described [here](https://en.bitcoin.it/wiki/Base58Check_encoding). as described [here](https://en.bitcoin.it/wiki/Base58Check_encoding).
A comprehensive suite of tests is provided to ensure proper functionality. A comprehensive suite of tests is provided to ensure proper functionality.
Package base58 is licensed under the copyfree ISC license.
## Documentation ## Installation and Updating
[![GoDoc](https://godoc.org/github.com/btcsuite/btcutil/base58?status.png)]
(http://godoc.org/github.com/btcsuite/btcutil/base58)
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/btcutil/base58
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/btcutil/base58
## Installation
```bash ```bash
$ go get github.com/btcsuite/btcutil/base58 $ go get -u github.com/btcsuite/btcutil/base58
``` ```
## Examples ## Examples

26
bloom/README.md
View file

@ -1,33 +1,23 @@
bloom bloom
===== =====
[![Build Status](https://travis-ci.org/btcsuite/btcutil.png?branch=master)] [![Build Status](http://img.shields.io/travis/btcsuite/btcutil.svg)]
(https://travis-ci.org/btcsuite/btcutil) (https://travis-ci.org/btcsuite/btcutil) [![ISC License]
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](http://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcutil/bloom)
Package bloom provides an API for dealing with bitcoin-specific bloom filters. Package bloom provides an API for dealing with bitcoin-specific bloom filters.
A comprehensive suite of tests is provided to ensure proper functionality. See A comprehensive suite of tests is provided to ensure proper functionality. See
`test_coverage.txt` for the gocov coverage report. Alternatively, if you are `test_coverage.txt` for the gocov coverage report. Alternatively, if you are
running a POSIX OS, you can run the `cov_report.sh` script for a real-time running a POSIX OS, you can run the `cov_report.sh` script for a real-time
report. Package coinset is licensed under the liberal ISC license. report.
## Documentation ## Installation and Updating
[![GoDoc](https://godoc.org/github.com/btcsuite/btcutil/bloom?status.png)]
(http://godoc.org/github.com/btcsuite/btcutil/bloom)
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/btcutil/bloom
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/btcutil/bloom
## Installation
```bash ```bash
$ go get github.com/btcsuite/btcutil/bloom $ go get -u github.com/btcsuite/btcutil/bloom
``` ```
## Examples ## Examples

26
coinset/README.md
View file

@ -1,8 +1,11 @@
coinset coinset
======= =======
[![Build Status](https://travis-ci.org/btcsuite/btcutil.png?branch=master)] [![Build Status](http://img.shields.io/travis/btcsuite/btcutil.svg)]
(https://travis-ci.org/btcsuite/btcutil) (https://travis-ci.org/btcsuite/btcutil) [![ISC License]
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](http://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcutil/coinset)
Package coinset provides bitcoin-specific convenience functions for selecting Package coinset provides bitcoin-specific convenience functions for selecting
from and managing sets of unspent transaction outpoints (UTXOs). from and managing sets of unspent transaction outpoints (UTXOs).
@ -10,25 +13,12 @@ from and managing sets of unspent transaction outpoints (UTXOs).
A comprehensive suite of tests is provided to ensure proper functionality. See A comprehensive suite of tests is provided to ensure proper functionality. See
`test_coverage.txt` for the gocov coverage report. Alternatively, if you are `test_coverage.txt` for the gocov coverage report. Alternatively, if you are
running a POSIX OS, you can run the `cov_report.sh` script for a real-time running a POSIX OS, you can run the `cov_report.sh` script for a real-time
report. Package coinset is licensed under the liberal ISC license. report.
## Documentation ## Installation and Updating
[![GoDoc](https://godoc.org/github.com/btcsuite/btcutil/coinset?status.png)]
(http://godoc.org/github.com/btcsuite/btcutil/coinset)
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/btcutil/coinset
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/btcutil/coinset
## Installation
```bash ```bash
$ go get github.com/btcsuite/btcutil/coinset $ go get -u github.com/btcsuite/btcutil/coinset
``` ```
## Usage ## Usage

26
hdkeychain/README.md
View file

@ -1,8 +1,11 @@
hdkeychain hdkeychain
========== ==========
[![Build Status](https://travis-ci.org/btcsuite/btcutil.png?branch=master)] [![Build Status](http://img.shields.io/travis/btcsuite/btcutil.svg)]
(https://travis-ci.org/btcsuite/btcutil) (https://travis-ci.org/btcsuite/btcutil) [![ISC License]
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](http://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcutil/hdkeychain)
Package hdkeychain provides an API for bitcoin hierarchical deterministic Package hdkeychain provides an API for bitcoin hierarchical deterministic
extended keys (BIP0032). extended keys (BIP0032).
@ -10,7 +13,7 @@ extended keys (BIP0032).
A comprehensive suite of tests is provided to ensure proper functionality. See A comprehensive suite of tests is provided to ensure proper functionality. See
`test_coverage.txt` for the gocov coverage report. Alternatively, if you are `test_coverage.txt` for the gocov coverage report. Alternatively, if you are
running a POSIX OS, you can run the `cov_report.sh` script for a real-time running a POSIX OS, you can run the `cov_report.sh` script for a real-time
report. Package hdkeychain is licensed under the liberal ISC license. report.
## Feature Overview ## Feature Overview
@ -35,23 +38,10 @@ report. Package hdkeychain is licensed under the liberal ISC license.
- Comprehensive test coverage including the BIP0032 test vectors - Comprehensive test coverage including the BIP0032 test vectors
- Benchmarks - Benchmarks
## Documentation ## Installation and Updating
[![GoDoc](https://godoc.org/github.com/btcsuite/btcutil/hdkeychain?status.png)]
(http://godoc.org/github.com/btcsuite/btcutil/hdkeychain)
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/btcutil/hdkeychain
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/btcutil/hdkeychain
## Installation
```bash ```bash
$ go get github.com/btcsuite/btcutil/hdkeychain $ go get -u github.com/btcsuite/btcutil/hdkeychain
``` ```
## Examples ## Examples

15
txsort/README.md
View file

@ -4,6 +4,8 @@ txsort
[![Build Status](http://img.shields.io/travis/btcsuite/btcutil.svg)] [![Build Status](http://img.shields.io/travis/btcsuite/btcutil.svg)]
(https://travis-ci.org/btcsuite/btcutil) [![ISC License] (https://travis-ci.org/btcsuite/btcutil) [![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](http://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcutil/txsort)
Package txsort provides the transaction sorting according to BIPLI01. Package txsort provides the transaction sorting according to BIPLI01.
@ -19,19 +21,6 @@ breaker.
A comprehensive suite of tests is provided to ensure proper functionality. A comprehensive suite of tests is provided to ensure proper functionality.
## Documentation
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcutil/txsort)
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/btcutil/txsort
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/btcutil/txsort
## Installation and Updating ## Installation and Updating
```bash ```bash