btcd/mining/README.md

mining
======

[![Build Status](https://github.com/btcsuite/btcd/workflows/Build%20and%20Test/badge.svg)](https://github.com/btcsuite/btcd/actions)
[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://pkg.go.dev/github.com/btcsuite/btcd/mining)

## Overview

This package is currently a work in progress.

## Installation and Updating

```bash
$ go get -u github.com/btcsuite/btcd/mining
```

## License

Package mining is licensed under the [copyfree](http://copyfree.org) ISC
License.
mining: Create skeleton package. This creates a skeleton mining package that simply contains a few of the definitions used by the mining and mempool code. This is a step towards decoupling the mining code from the internals of btcd and ultimately will house all of the code related to creating block templates and CPU mining. The main reason a skeleton package is being created before the full blown package is ready is to avoid blocking mempool separation which relies on these type definitions. 2015-11-25 16:27:14 -06:00			`mining`
			`======`

docs: update shields 2021-03-04 17:12:45 -05:00			`[![Build Status](https://github.com/btcsuite/btcd/workflows/Build%20and%20Test/badge.svg)](https://github.com/btcsuite/btcd/actions)`
multi: Update markdown files for GFM changes. The github markdown interpreter has been changed such that it no longer allows spaces in between the brackets and parenthesis of links and now requires a newline in between anchors and other formatting. This updates all of the markdown files accordingly. While here, it also corrects a couple of inconsistencies in some of the README.md files. 2017-05-25 11:29:23 -05:00			`[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)`
docs: update shields 2021-03-04 17:12:45 -05:00			`[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://pkg.go.dev/github.com/btcsuite/btcd/mining)`
mining: Create skeleton package. This creates a skeleton mining package that simply contains a few of the definitions used by the mining and mempool code. This is a step towards decoupling the mining code from the internals of btcd and ultimately will house all of the code related to creating block templates and CPU mining. The main reason a skeleton package is being created before the full blown package is ready is to avoid blocking mempool separation which relies on these type definitions. 2015-11-25 16:27:14 -06:00
			`## Overview`

			`This package is currently a work in progress.`

			`## Installation and Updating`

			```bash
			`$ go get -u github.com/btcsuite/btcd/mining`
			```

			`## License`

			`Package mining is licensed under the [copyfree](http://copyfree.org) ISC`
			`License.`