3942a116e4
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. Finally, 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.
66 lines
2.1 KiB
Markdown
66 lines
2.1 KiB
Markdown
database
|
|
========
|
|
|
|
[]
|
|
(https://travis-ci.org/btcsuite/btcd) [![ISC License]
|
|
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
|
|
[]
|
|
(http://godoc.org/github.com/btcsuite/btcd/database)
|
|
|
|
Package database provides a database interface for the bitcoin block chain and
|
|
transactions.
|
|
|
|
Please note that this package is intended to enable btcd to support different
|
|
database backends and is not something that a client can directly access as only
|
|
one entity can have the database open at a time (for most database backends),
|
|
and that entity will be btcd.
|
|
|
|
When a client wants programmatic access to the data provided by btcd, they'll
|
|
likely want to use the [btcrpcclient](https://github.com/btcsuite/btcrpcclient)
|
|
package which makes use of the [JSON-RPC API]
|
|
(https://github.com/btcsuite/btcd/tree/master/docs/json_rpc_api.md).
|
|
|
|
## Installation and Updating
|
|
|
|
```bash
|
|
$ go get -u github.com/btcsuite/btcd/database
|
|
```
|
|
|
|
## Examples
|
|
|
|
* [CreateDB Example]
|
|
(http://godoc.org/github.com/btcsuite/btcd/database#example-CreateDB)
|
|
Demonstrates creating a new database and inserting the genesis block into it.
|
|
|
|
* [NewestSha Example]
|
|
(http://godoc.org/github.com/btcsuite/btcd/database#example-Db--NewestSha)
|
|
Demonstrates querying the database for the most recent best block height and
|
|
hash.
|
|
|
|
## TODO
|
|
- Increase test coverage to 100%
|
|
|
|
## 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 database is licensed under the [copyfree](http://copyfree.org) ISC
|
|
License.
|