mirrors/btcd
1
0
Fork 0
mirror of https://github.com/btcsuite/btcd.git synced 2024-11-19 01:40:07 +01:00
Code Issues Projects Releases Wiki Activity

Clarify how the database package is used.

Browse Source
This commit is contained in:
Dave Collins 2015-01-27 18:58:27 -06:00
parent 309a9ea31d
commit dd64dd96e9
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
database/README.md
View File

@ -8,6 +8,16 @@ 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).
## Documentation
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]