Skip to content
This repository has been archived by the owner on Aug 7, 2023. It is now read-only.

Commit

Permalink
multi: Update markdown in README files to match change in github parser.
Browse files Browse the repository at this point in the history
This borrows a lot from btcsuite/btcd 9918e2a
  • Loading branch information
jcvernaleo committed May 26, 2017
1 parent e1f9455 commit e7b128a
Show file tree
Hide file tree
Showing 16 changed files with 60 additions and 142 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
dcrd
====

[![Build Status](http://img.shields.io/travis/decred/dcrd.svg)]
(https://travis-ci.org/decred/dcrd) [![ISC License]
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![Build Status](https://travis-ci.org/decred/dcrd.png?branch=master)](https://travis-ci.org/decred/dcrd)
[![ISC License](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/decred/dcrd)

dcrd is a Decred full node implementation written in Go (golang).

Expand Down
17 changes: 6 additions & 11 deletions blockchain/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
blockchain
==========

[![Build Status](http://img.shields.io/travis/decred/dcrd.svg)]
(https://travis-ci.org/decred/dcrd) [![ISC License]
(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/decred/dcrd/blockchain)
[![Build Status](http://img.shields.io/travis/decred/dcrd.svg)](https://travis-ci.org/decred/dcrd)
[![ISC License](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/decred/dcrd/blockchain)

Package blockchain implements decred block handling and chain selection rules.
The test coverage is currently only around 60%, but will be increasing over
Expand Down Expand Up @@ -63,21 +61,18 @@ is by no means exhaustive:

## Examples

* [ProcessBlock Example]
(http://godoc.org/github.com/decred/dcrd/blockchain#example-BlockChain-ProcessBlock)
* [ProcessBlock Example](http://godoc.org/github.com/decred/dcrd/blockchain#example-BlockChain-ProcessBlock)
Demonstrates how to create a new chain instance and use ProcessBlock to
attempt to attempt add a block to the chain. This example intentionally
attempts to insert a duplicate genesis block to illustrate how an invalid
block is handled.

* [CompactToBig Example]
(http://godoc.org/github.com/decred/dcrd/blockchain#example-CompactToBig)
* [CompactToBig Example](http://godoc.org/github.com/decred/dcrd/blockchain#example-CompactToBig)
Demonstrates how to convert the compact "bits" in a block header which
represent the target difficulty to a big integer and display it using the
typical hex notation.

* [BigToCompact Example]
(http://godoc.org/github.com/decred/dcrd/blockchain#example-BigToCompact)
* [BigToCompact Example](http://godoc.org/github.com/decred/dcrd/blockchain#example-BigToCompact)
Demonstrates how to convert how to convert a target difficulty into the
compact "bits" in a block header which represent that target difficulty.

Expand Down
18 changes: 3 additions & 15 deletions blockchain/indexers/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
indexers
========

[![Build Status](https://travis-ci.org/btcsuite/btcd.png?branch=master)]
(https://travis-ci.org/btcsuite/btcd)
[![Build Status](https://travis-ci.org/decred/dcrd.png?branch=master)](https://travis-ci.org/decred/dcrd)
[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](https://godoc.org/github.com/decred/dcrd/blockchain/indexers?status.png)](http://godoc.org/github.com/decred/dcrd/blockchain/indexers)

Package indexers implements optional block chain indexes.

Expand All @@ -23,19 +24,6 @@ via an RPC interface.
and was seen by the client
- Requires the transaction-by-hash index

## Documentation

[![GoDoc](https://godoc.org/github.com/decred/dcrd/blockchain/indexers?status.png)]
(http://godoc.org/github.com/decred/dcrd/blockchain/indexers)

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/indexers

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/decred/dcrd/blockchain/indexers

## Installation

```bash
Expand Down
8 changes: 3 additions & 5 deletions chaincfg/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
chaincfg
========

[![Build Status](http://img.shields.io/travis/decred/dcrd.svg)]
(https://travis-ci.org/decred/dcrd) [![ISC License]
(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/decred/dcrd/chaincfg)
[![Build Status](http://img.shields.io/travis/decred/dcrd.svg)](https://travis-ci.org/decred/dcrd)
[![ISC License](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/decred/dcrd/chaincfg)

Package chaincfg defines chain configuration parameters for the three standard
Decred networks and provides the ability for callers to define their own custom
Expand Down
8 changes: 3 additions & 5 deletions chaincfg/chainhash/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
chainhash
=========

[![Build Status](http://img.shields.io/travis/decred/dcrd.svg)]
(https://travis-ci.org/decred/dcrd) [![ISC License]
(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/decred/dcrd/chaincfg/chainhash)
[![Build Status](http://img.shields.io/travis/decred/dcrd.svg)](https://travis-ci.org/decred/dcrd)
[![ISC License](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/decred/dcrd/chaincfg/chainhash)

chainhash provides a generic hash type and associated functions that allows the
specific hash algorithm to be abstracted.
Expand Down
8 changes: 3 additions & 5 deletions connmgr/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
connmgr
=======

[![Build Status](http://img.shields.io/travis/decred/dcrd.svg)]
(https://travis-ci.org/decred/dcrd) [![ISC License]
(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/decred/dcrd/connmgr)
[![Build Status](http://img.shields.io/travis/decred/dcrd.svg)](https://travis-ci.org/decred/dcrd)
[![ISC License](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/decred/dcrd/connmgr)

Package connmgr implements a generic Decred network connection manager.

Expand Down
27 changes: 6 additions & 21 deletions database/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
database
========

[![Build Status](https://travis-ci.org/decred/dcrd.png?branch=master)]
(https://travis-ci.org/decred/dcrd)
[![Build Status](http://img.shields.io/travis/decred/dcrd.svg)](https://travis-ci.org/decred/dcrd)
[![ISC License](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/decred/dcrd/database)

Package database provides a block and metadata storage database.

Expand All @@ -13,8 +14,7 @@ and that entity will be dcrd.

When a client wants programmatic access to the data provided by dcrd, they'll
likely want to use the [dcrrpcclient](https://github.com/decred/dcrrpcclient)
package which makes use of the [JSON-RPC API]
(https://github.com/decred/dcrd/tree/master/docs/json_rpc_api.md).
package which makes use of the [JSON-RPC API](https://github.com/decred/dcrd/tree/master/docs/json_rpc_api.md).

However, this package could be extremely useful for any applications requiring
Decred block storage capabilities.
Expand All @@ -34,19 +34,6 @@ storage, and strict checksums in key areas to ensure data integrity.
- Supports registration of backend databases
- Comprehensive test coverage

## Documentation

[![GoDoc](https://godoc.org/github.com/decred/dcrd/database2?status.png)]
(http://godoc.org/github.com/decred/dcrd/database2)

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/decred/dcrd/database2

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/decred/dcrd/database2

## Installation

```bash
Expand All @@ -55,13 +42,11 @@ $ go get github.com/decred/dcrd/database2

## Examples

* [Basic Usage Example]
(http://godoc.org/github.com/decred/dcrd/database2#example-package--BasicUsage)
* [Basic Usage Example](http://godoc.org/github.com/decred/dcrd/database2#example-package--BasicUsage)
Demonstrates creating a new database and using a managed read-write
transaction to store and retrieve metadata.

* [Block Storage and Retrieval Example]
(http://godoc.org/github.com/decred/dcrd/database2#example-package--BlockStorageAndRetrieval)
* [Block Storage and Retrieval Example](http://godoc.org/github.com/decred/dcrd/database2#example-package--BlockStorageAndRetrieval)
Demonstrates creating a new database, using a managed read-write transaction
to store a block, and then using a managed read-only transaction to fetch the
block.
Expand Down
18 changes: 3 additions & 15 deletions database/ffldb/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
ffldb
=====

[![Build Status](https://travis-ci.org/decred/dcrd.png?branch=master)]
(https://travis-ci.org/decred/dcrd)
[![Build Status](http://img.shields.io/travis/decred/dcrd.svg)](https://travis-ci.org/decred/dcrd)
[![ISC License](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/decred/dcrd/database/ffldb)

Package ffldb implements a driver for the database package that uses leveldb for
the backing metadata and flat files for block storage.
Expand Down Expand Up @@ -33,19 +34,6 @@ if err != nil {
}
```

## Documentation

[![GoDoc](https://godoc.org/github.com/decred/dcrd/database2/ffldb?status.png)]
(http://godoc.org/github.com/decred/dcrd/database2/ffldb)

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/decred/dcrd/database2/ffldb

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/decred/dcrd/database2/ffldb

## License

Package ffldb is licensed under the [copyfree](http://copyfree.org) ISC
Expand Down
18 changes: 3 additions & 15 deletions database/internal/treap/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
treap
=====

[![Build Status](https://travis-ci.org/decred/dcrd.png?branch=master)]
(https://travis-ci.org/decred/dcrd)
[![Build Status](http://img.shields.io/travis/decred/dcrd.svg)](https://travis-ci.org/decred/dcrd)
[![ISC License](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/decred/dcrd/database/internal/treap)

Package treap implements a treap data structure that is used to hold ordered
key/value pairs using a combination of binary search tree and heap semantics.
Expand Down Expand Up @@ -32,19 +33,6 @@ Package treap is licensed under the copyfree ISC license.
This package is only used internally in the database code and as such is not
available for use outside of it.

## Documentation

[![GoDoc](https://godoc.org/github.com/decred/dcrd/database2/internal/treap?status.png)]
(http://godoc.org/github.com/decred/dcrd/database/internal/treap)

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/decred/dcrd/database2/internal/treap

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/decred/dcrd/database2/internal/treap

## License

Package treap is licensed under the [copyfree](http://copyfree.org) ISC
Expand Down
20 changes: 7 additions & 13 deletions dcrjson/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
dcrjson
=======

[![Build Status](http://img.shields.io/travis/decred/dcrd.svg)]
(https://travis-ci.org/decred/dcrd) [![ISC License]
(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/decred/dcrd/dcrjson)
[![Build Status](https://travis-ci.org/decred/dcrd.png?branch=master)](https://travis-ci.org/decred/dcrd)
[![ISC License](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/decred/dcrd/dcrjson)

Package dcrjson implements concrete types for marshalling to and from the
bitcoin JSON-RPC API. A comprehensive suite of tests is provided to ensure
Expand All @@ -32,21 +30,17 @@ $ go get -u github.com/decred/dcrd/dcrjson

## Examples

* [Marshal Command]
(http://godoc.org/github.com/decred/dcrd/dcrjson#example-MarshalCmd)
* [Marshal Command](http://godoc.org/github.com/decred/dcrd/dcrjson#example-MarshalCmd)
Demonstrates how to create and marshal a command into a JSON-RPC request.

* [Unmarshal Command]
(http://godoc.org/github.com/decred/dcrd/dcrjson#example-UnmarshalCmd)
* [Unmarshal Command](http://godoc.org/github.com/decred/dcrd/dcrjson#example-UnmarshalCmd)
Demonstrates how to unmarshal a JSON-RPC request and then unmarshal the
concrete request into a concrete command.

* [Marshal Response]
(http://godoc.org/github.com/decred/dcrd/dcrjson#example-MarshalResponse)
* [Marshal Response](http://godoc.org/github.com/decred/dcrd/dcrjson#example-MarshalResponse)
Demonstrates how to marshal a JSON-RPC response.

* [Unmarshal Response]
(http://godoc.org/github.com/decred/dcrd/dcrjson#example-package--UnmarshalResponse)
* [Unmarshal Response](http://godoc.org/github.com/decred/dcrd/dcrjson#example-package--UnmarshalResponse)
Demonstrates how to unmarshal a JSON-RPC response and then unmarshal the
result field in the response to a concrete type.

Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,4 +202,4 @@ information.
Provides a generic hash type and associated functions that allows the
specific hash algorithm to be abstracted.
* [connmgr](https://github.com/decred/dcrd/tree/master/connmgr) -
Package connmgr implements a generic Decred network connection manager.
Package connmgr implements a generic Decred network connection manager.
8 changes: 3 additions & 5 deletions mempool/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
mempool
=======

[![Build Status](http://img.shields.io/travis/decred/dcrd.svg)]
(https://travis-ci.org/decred/dcrd) [![ISC License]
(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/decred/dcrd/mempool)
[![Build Status](http://img.shields.io/travis/decred/dcrd.svg)](https://travis-ci.org/decred/dcrd)
[![ISC License](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/decred/dcrd/mempool)

## Overview

Expand Down
8 changes: 3 additions & 5 deletions mining/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
mining
======

[![Build Status](http://img.shields.io/travis/decred/dcrd.svg)]
(https://travis-ci.org/decred/dcrd) [![ISC License]
(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/decred/dcrd/mining)
[![Build Status](http://img.shields.io/travis/decred/dcrd.svg)](https://travis-ci.org/decred/dcrd)
[![ISC License](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/decred/dcrd/mining)

## Overview

Expand Down
11 changes: 4 additions & 7 deletions peer/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
peer
====

[![Build Status](http://img.shields.io/travis/decred/dcrd.svg)]
(https://travis-ci.org/decred/dcrd) [![ISC License]
(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/decred/dcrd/peer)
[![Build Status](http://img.shields.io/travis/decred/dcrd.svg)](https://travis-ci.org/decred/dcrd)
[![ISC License](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/decred/dcrd/peer)

Package peer provides a common base for creating and managing bitcoin network
peers.
Expand Down Expand Up @@ -65,8 +63,7 @@ $ go get -u github.com/decred/dcrd/peer

## Examples

* [New Outbound Peer Example]
(https://godoc.org/github.com/decred/dcrd/peer#example-package--NewOutboundPeer)
* [New Outbound Peer Example](https://godoc.org/github.com/decred/dcrd/peer#example-package--NewOutboundPeer)
Demonstrates the basic process for initializing and creating an outbound peer.
Peers negotiate by exchanging version and verack messages. For demonstration,
a simple handler for the version message is attached to the peer.
Expand Down
17 changes: 6 additions & 11 deletions txscript/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
txscript
========

[![Build Status](https://travis-ci.org/decred/dcrd.png?branch=master)]
(https://travis-ci.org/decred/dcrd) [![ISC License]
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](https://godoc.org/github.com/decred/dcrd/txscript?status.png)]
(http://godoc.org/github.com/decred/dcrd/txscript)
[![Build Status](http://img.shields.io/travis/decred/dcrd.svg)](https://travis-ci.org/decred/dcrd)
[![ISC License](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/decred/dcrd/txscript)

Package txscript implements the decred transaction script language. There is
a comprehensive test suite.
Expand All @@ -27,18 +25,15 @@ $ go get -u github.com/decred/dcrd/txscript

## Examples

* [Standard Pay-to-pubkey-hash Script]
(http://godoc.org/github.com/decred/dcrd/txscript#example-PayToAddrScript)
* [Standard Pay-to-pubkey-hash Script](http://godoc.org/github.com/decred/dcrd/txscript#example-PayToAddrScript)
Demonstrates creating a script which pays to a decred address. It also
prints the created script hex and uses the DisasmString function to display
the disassembled script.

* [Extracting Details from Standard Scripts]
(http://godoc.org/github.com/decred/dcrd/txscript#example-ExtractPkScriptAddrs)
* [Extracting Details from Standard Scripts](http://godoc.org/github.com/decred/dcrd/txscript#example-ExtractPkScriptAddrs)
Demonstrates extracting information from a standard public key script.

* [Manually Signing a Transaction Output]
(http://godoc.org/github.com/decred/dcrd/txscript#example-SignTxOutput)
* [Manually Signing a Transaction Output](http://godoc.org/github.com/decred/dcrd/txscript#example-SignTxOutput)
Demonstrates manually creating and signing a redeem transaction.

## License
Expand Down
Loading

0 comments on commit e7b128a

Please sign in to comment.