From dd64dd96e94c91b3f24c39f40cf6f84f2c105304 Mon Sep 17 00:00:00 2001 From: Dave Collins Date: Tue, 27 Jan 2015 18:58:27 -0600 Subject: [PATCH] Clarify how the database package is used. --- database/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/database/README.md b/database/README.md index bac1f2645..a46ff4ccf 100644 --- a/database/README.md +++ b/database/README.md @@ -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)]