-
Notifications
You must be signed in to change notification settings - Fork 56
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update readme to reflect masters current state.
- Loading branch information
Showing
1 changed file
with
1 addition
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1 @@ | ||
[](https://travis-ci.org/libbitcoin/libbitcoin-database) | ||
|
||
[](https://coveralls.io/r/libbitcoin/libbitcoin-database) | ||
|
||
# Libbitcoin Database | ||
|
||
*Bitcoin High Performance Blockchain Database* | ||
|
||
Make sure you have installed [libbitcoin](https://github.com/libbitcoin/libbitcoin-system) beforehand according to its build instructions. | ||
|
||
```sh | ||
$ ./autogen.sh | ||
$ ./configure | ||
$ make | ||
$ sudo make install | ||
$ sudo ldconfig | ||
``` | ||
|
||
libbitcoin-database is now installed in `/usr/local/`. | ||
|
||
**About Libbitcoin Database** | ||
|
||
Libbitcoin Database is a custom database build directly on the operating system's [memory-mapped file](https://en.wikipedia.org/wiki/Memory-mapped_file) system. All primary tables and indexes are built on in-memory hash tables, resulting in constant-time lookups. The database uses [sequence locking](https://en.wikipedia.org/wiki/Seqlock) to avoid blocking the writer. This is ideal for a high performance blockchain server as reads are significantly more frequent than writes and yet writes must proceed without delay. The [libbitcoin-blockchain](https://github.com/libbitcoin/libbitcoin-blockchain) library uses the database as its blockchain store. | ||
|
||
## Installation | ||
|
||
### Macintosh | ||
|
||
#### Using Homebrew | ||
|
||
##### Installing from Formula | ||
|
||
Instead of building, libbitcoin-database can be installed from a formula: | ||
```sh | ||
$ brew install libbitcoin-database | ||
``` | ||
This branch is not usable in its current state. Please see [version3](https://github.com/libbitcoin/libbitcoin-database/tree/version3) for the latest functional branch. |