btcd/chaincfg/chainhash/README.md

chainhash
=========

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

chainhash provides a generic hash type and associated functions that allows the
specific hash algorithm to be abstracted.

## Installation and Updating

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

## GPG Verification Key

All official release tags are signed by Conformal so users can ensure the code
has not been tampered with and is coming from the btcsuite developers.  To
verify the signature perform the following:

- Download the public key from the Conformal website at
  https://opensource.conformal.com/GIT-GPG-KEY-conformal.txt

- Import the public key into your GPG keyring:
  ```bash
  gpg --import GIT-GPG-KEY-conformal.txt
  ```

- Verify the release tag with the following command where `TAG_NAME` is a
  placeholder for the specific tag:
  ```bash
  git tag -v TAG_NAME
  ```

## License

Package chainhash is licensed under the [copyfree](http://copyfree.org) ISC
License.
chainhash: Implement a new chainhash package. (#730) This is a backport of the chainhash package made in Decred along with a few additional things cleaned up, finished test coverage, and rewording of some documentation to make it more generic. In particular, the new package provides the definition of the hash type and associated hashing functions which will allow the rest of the code to be agnostic to the specific hash algorithm. This only implements the package and does not change any of the code base over to use it. 2016-08-08 12:05:51 -05:00			`chainhash`
			`=========`

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			`[![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)](https://travis-ci.org/btcsuite/btcd)`
			`[![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/btcsuite/btcd/chaincfg/chainhash)`
multi: update to point to roasbeef forks 2017-08-24 16:29:38 -07:00			`=======`
chainhash: Implement a new chainhash package. (#730) This is a backport of the chainhash package made in Decred along with a few additional things cleaned up, finished test coverage, and rewording of some documentation to make it more generic. In particular, the new package provides the definition of the hash type and associated hashing functions which will allow the rest of the code to be agnostic to the specific hash algorithm. This only implements the package and does not change any of the code base over to use it. 2016-08-08 12:05:51 -05:00
			`chainhash provides a generic hash type and associated functions that allows the`
			`specific hash algorithm to be abstracted.`

			`## Installation and Updating`

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

			`## GPG Verification Key`

			`All official release tags are signed by Conformal so users can ensure the code`
			`has not been tampered with and is coming from the btcsuite developers. To`
			`verify the signature perform the following:`

			`- Download the public key from the Conformal website at`
			`https://opensource.conformal.com/GIT-GPG-KEY-conformal.txt`

			`- Import the public key into your GPG keyring:`
			```bash
			`gpg --import GIT-GPG-KEY-conformal.txt`
			```

			- Verify the release tag with the following command where `TAG_NAME` is a
			`placeholder for the specific tag:`
			```bash
			`git tag -v TAG_NAME`
			```

			`## License`

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