Skip to content

Commit 0885acf

Browse files
committedJul 14, 2022
Update readme to reflect masters current state.
1 parent 29c8a9b commit 0885acf

File tree

1 file changed

+1
-36
lines changed

1 file changed

+1
-36
lines changed
 

‎README.md

+1-36
Original file line numberDiff line numberDiff line change
@@ -1,36 +1 @@
1-
[![Build Status](https://travis-ci.org/libbitcoin/libbitcoin-database.svg?branch=master)](https://travis-ci.org/libbitcoin/libbitcoin-database)
2-
3-
[![Coverage Status](https://coveralls.io/repos/libbitcoin/libbitcoin-database/badge.svg)](https://coveralls.io/r/libbitcoin/libbitcoin-database)
4-
5-
# Libbitcoin Database
6-
7-
*Bitcoin High Performance Blockchain Database*
8-
9-
Make sure you have installed [libbitcoin](https://github.com/libbitcoin/libbitcoin-system) beforehand according to its build instructions.
10-
11-
```sh
12-
$ ./autogen.sh
13-
$ ./configure
14-
$ make
15-
$ sudo make install
16-
$ sudo ldconfig
17-
```
18-
19-
libbitcoin-database is now installed in `/usr/local/`.
20-
21-
**About Libbitcoin Database**
22-
23-
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.
24-
25-
## Installation
26-
27-
### Macintosh
28-
29-
#### Using Homebrew
30-
31-
##### Installing from Formula
32-
33-
Instead of building, libbitcoin-database can be installed from a formula:
34-
```sh
35-
$ brew install libbitcoin-database
36-
```
1+
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.

0 commit comments

Comments
 (0)
Please sign in to comment.