1ffldb
2=====
3
4[![Build Status](https://travis-ci.org/btcsuite/btcd.png?branch=master)](https://travis-ci.org/btcsuite/btcd)
5[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
6[![GoDoc](https://godoc.org/github.com/btcsuite/btcd/database/ffldb?status.png)](http://godoc.org/github.com/btcsuite/btcd/database/ffldb)
7=======
8
9Package ffldb implements a driver for the database package that uses leveldb for
10the backing metadata and flat files for block storage.
11
12This driver is the recommended driver for use with btcd.  It makes use leveldb
13for the metadata, flat files for block storage, and checksums in key areas to
14ensure data integrity.
15
16Package ffldb is licensed under the copyfree ISC license.
17
18## Usage
19
20This package is a driver to the database package and provides the database type
21of "ffldb".  The parameters the Open and Create functions take are the
22database path as a string and the block network.
23
24```Go
25db, err := database.Open("ffldb", "path/to/database", wire.MainNet)
26if err != nil {
27	// Handle error
28}
29```
30
31```Go
32db, err := database.Create("ffldb", "path/to/database", wire.MainNet)
33if err != nil {
34	// Handle error
35}
36```
37
38## License
39
40Package ffldb is licensed under the [copyfree](http://copyfree.org) ISC
41License.
42