<commit_before>Master [![Circle CI](https://circleci.com/gh/eris-ltd/eris-db/tree/master.svg?style=svg)](https://circleci.com/gh/eris-ltd/eris-db)
 Develop [![Circle CI (develop)](https://circleci.com/gh/eris-ltd/eris-db/tree/develop.svg?style=svg)](https://circleci.com/gh/eris-ltd/eris-db)

# Eris-DB (Alpha)

`eris-db` is Eris' blockchain-client. It consists of a [Tendermint](http://tendermint.com/) node wrapped by a simple server. The server allows requests to be made over HTTP - either using JSON-RPC 2.0 or a RESTlike web-api - and websocket (JSON-RPC 2.0). The web-APIs are documented in `api.md`. We also have javascript bindings for the RPC methods in [eris-db.js](https://github.com/eris-ltd/eris-db.js).

## Installation

There are no pre-built releases other then the docker images.

The recommended way of working with eris-db is through [eris-cli](https://github.com/eris-ltd/eris-cli) (develop branch as of now).

### Building from source

#### Ubuntu 14.04 (OSX ?)

Make sure you have the proper [Go](https://golang.org/) distribution for your OS and architecture. The recommended version is `1.4.2`. Follow the instructions on how to set up GOROOT and GOPATH.

You will also need the following libraries: `git, libgmp3-dev`

On Ubuntu: `sudo apt-get install git libgmp3-dev`

On Mac: `brew install git gmp`

Next you pull in the code:

`go get github.com/eris-ltd/eris-db/cmd/erisdb`

This will build and install the `erisdb` executable and put it in `$GOPATH/bin`, which should be on your PATH. If not, then add it.

To run `erisdb`, just type `$ erisdb /path/to/working/folder`

This will start the node using the provided folder as working dir. If the path is omitted it defaults to `~/.erisdb` 

#### Docker

It is best to use [eris-cli](https://github.com/eris-ltd/eris-cli) which will help setting up and running eris-db (and individual chains) through docker.

##### Others

Tendermint officially supports only 64 bit Ubuntu. 
<commit_msg>add godoc & update README<commit_after>|[![GoDoc](https://godoc.org/github.com/eris-db?status.png)](https://godoc.org/github.com/eris-ltd/eris-db) | Linux |
|---|-------|
| Master | [![Circle CI](https://circleci.com/gh/eris-ltd/eris-db/tree/master.svg?style=svg)](https://circleci.com/gh/eris-ltd/eris-db) |
| Develop | [![Circle CI (develop)](https://circleci.com/gh/eris-ltd/eris-db/tree/develop.svg?style=svg)](https://circleci.com/gh/eris-ltd/eris-db) |

# Eris-DB (Alpha)

`eris-db` is Eris' blockchain-client. It consists of a [Tendermint](http://tendermint.com/) node wrapped by a simple server. The server allows requests to be made over HTTP - either using JSON-RPC 2.0 or a RESTlike web-api - and websocket (JSON-RPC 2.0). The web-APIs are documented in `api.md`. We also have javascript bindings for the RPC methods in [eris-db.js](https://github.com/eris-ltd/eris-db.js).

## Installation

There are no pre-built releases other than the docker images.

The recommended way of working with eris-db is through [eris-cli](https://github.com/eris-ltd/eris-cli). See the [eris-db documentation](https://erisindustries.com/components/erisdb/) for more information.

### Building from source

#### Ubuntu 14.04 (OSX ?)

Make sure you have the proper [Go](https://golang.org/) distribution for your OS and architecture. The recommended version is `1.4.2`. Follow the instructions on how to set up GOROOT and GOPATH.

You will also need the following libraries: `git, libgmp3-dev`

On Ubuntu: `sudo apt-get install git libgmp3-dev`

On Mac: `brew install git gmp`

Next you pull in the code:

`go get github.com/eris-ltd/eris-db/cmd/erisdb`

This will build and install the `erisdb` executable and put it in `$GOPATH/bin`, which should be on your PATH. If not, then add it.

To run `erisdb`, just type `$ erisdb /path/to/working/folder`

This will start the node using the provided folder as working dir. If the path is omitted it defaults to `~/.erisdb` 

#### Docker

It is best to use [eris-cli](https://github.com/eris-ltd/eris-cli) which will help setting up and running eris-db (and individual chains) through docker.

##### Others

Tendermint officially supports only 64 bit Ubuntu. 

{'fraction_non_alphanumeric': 0.1324200913242009, 'fraction_numerical': 0.007209805335255948, 'mean_word_length': 4.014457831325301, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 19, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 6, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1127924', 'n_tokens_mistral': 1472, 'n_tokens_neox': 1391, 'n_words': 475}