LBRYCommunity/lbcutil
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

multi: Update markdown files for GFM changes.

Browse source 
The github markdown interpreter has been changed such that it no longer
allows spaces in between the brackets and parenthesis of links.  This
updates all of the markdown files accordingly.

While here, it also corrects a couple of inconsistencies in regards to
other README.md files in the project.
This commit is contained in:
Dave Collins 2017-05-25 12:56:27 -05:00
parent 66871daeb1
commit fac8a9a582
No known key found for this signature in database
GPG key ID: B8904D9D9C93D1F2
6 changed files with 27 additions and 48 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -1,13 +1,10 @@
btcutil btcutil
======= =======
[![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)
(https://travis-ci.org/btcsuite/btcutil) [![Coverage Status] [![Coverage Status](http://img.shields.io/coveralls/btcsuite/btcutil.svg)](https://coveralls.io/r/btcsuite/btcutil?branch=master)
(http://img.shields.io/coveralls/btcsuite/btcutil.svg)] [![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
(https://coveralls.io/r/btcsuite/btcutil?branch=master) [![ISC License] [![GoDoc](http://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/btcsuite/btcutil)
(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

20
base58/README.md
View file

@ -1,11 +1,9 @@
base58 base58
========== ==========
[![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)
(https://travis-ci.org/btcsuite/btcutil) [![ISC License] [![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/btcutil/base58)
[![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,
@ -21,17 +19,13 @@ $ go get -u github.com/btcsuite/btcutil/base58
## Examples ## Examples
* [Decode Example] * [Decode Example](http://godoc.org/github.com/btcsuite/btcutil/base58#example-Decode)
(http://godoc.org/github.com/btcsuite/btcutil/base58#example-Decode)
Demonstrates how to decode modified base58 encoded data. Demonstrates how to decode modified base58 encoded data.
* [Encode Example] * [Encode Example](http://godoc.org/github.com/btcsuite/btcutil/base58#example-Encode)
(http://godoc.org/github.com/btcsuite/btcutil/base58#example-Encode)
Demonstrates how to encode data using the modified base58 encoding scheme. Demonstrates how to encode data using the modified base58 encoding scheme.
* [CheckDecode Example] * [CheckDecode Example](http://godoc.org/github.com/btcsuite/btcutil/base58#example-CheckDecode)
(http://godoc.org/github.com/btcsuite/btcutil/base58#example-CheckDecode)
Demonstrates how to decode Base58Check encoded data. Demonstrates how to decode Base58Check encoded data.
* [CheckEncode Example] * [CheckEncode Example](http://godoc.org/github.com/btcsuite/btcutil/base58#example-CheckEncode)
(http://godoc.org/github.com/btcsuite/btcutil/base58#example-CheckEncode)
Demonstrates how to encode data using the Base58Check encoding scheme. Demonstrates how to encode data using the Base58Check encoding scheme.
## License ## License

11
bloom/README.md
View file

@ -1,11 +1,9 @@
bloom bloom
===== =====
[![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)
(https://travis-ci.org/btcsuite/btcutil) [![ISC License] [![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/bloom)
[![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.
@ -22,8 +20,7 @@ $ go get -u github.com/btcsuite/btcutil/bloom
## Examples ## Examples
* [NewFilter Example] * [NewFilter Example](http://godoc.org/github.com/btcsuite/btcutil/bloom#example-NewFilter)
(http://godoc.org/github.com/btcsuite/btcutil/bloom#example-NewFilter)
Demonstrates how to create a new bloom filter, add a transaction hash to it, Demonstrates how to create a new bloom filter, add a transaction hash to it,
and check if the filter matches the transaction. and check if the filter matches the transaction.

8
coinset/README.md
View file

@ -1,11 +1,9 @@
coinset coinset
======= =======
[![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)
(https://travis-ci.org/btcsuite/btcutil) [![ISC License] [![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/coinset)
[![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).

17
hdkeychain/README.md
View file

@ -1,11 +1,9 @@
hdkeychain hdkeychain
========== ==========
[![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)
(https://travis-ci.org/btcsuite/btcutil) [![ISC License] [![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/hdkeychain)
[![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).
@ -46,16 +44,13 @@ $ go get -u github.com/btcsuite/btcutil/hdkeychain
## Examples ## Examples
* [NewMaster Example] * [NewMaster Example](http://godoc.org/github.com/btcsuite/btcutil/hdkeychain#example-NewMaster)
(http://godoc.org/github.com/btcsuite/btcutil/hdkeychain#example-NewMaster)
Demonstrates how to generate a cryptographically random seed then use it to Demonstrates how to generate a cryptographically random seed then use it to
create a new master node (extended key). create a new master node (extended key).
* [Default Wallet Layout Example] * [Default Wallet Layout Example](http://godoc.org/github.com/btcsuite/btcutil/hdkeychain#example-package--DefaultWalletLayout)
(http://godoc.org/github.com/btcsuite/btcutil/hdkeychain#example-package--DefaultWalletLayout)
Demonstrates the default hierarchical deterministic wallet layout as described Demonstrates the default hierarchical deterministic wallet layout as described
in BIP0032. in BIP0032.
* [Audits Use Case Example] * [Audits Use Case Example](http://godoc.org/github.com/btcsuite/btcutil/hdkeychain#example-package--Audits)
(http://godoc.org/github.com/btcsuite/btcutil/hdkeychain#example-package--Audits)
Demonstrates the audits use case in BIP0032. Demonstrates the audits use case in BIP0032.
## License ## License

8
txsort/README.md
View file

@ -1,11 +1,9 @@
txsort 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)
(https://travis-ci.org/btcsuite/btcutil) [![ISC License] [![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)
[![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 [BIP 69](https://github.com/bitcoin/bips/blob/master/bip-0069.mediawiki). Package txsort provides the transaction sorting according to [BIP 69](https://github.com/bitcoin/bips/blob/master/bip-0069.mediawiki).