<commit_before># eclib - Bindings for liberasurecode

[![Circle CI][circle]](https://circleci.com/gh/scality/eclib)
[![npm version][npm version]](https://www.npmjs.com/package/eclib)

eclib is a set of NodeJS bindings for [liberasurecode][liberasure]
and its backends.

### Installation

```sh
# We rely on node-gyp to build our binaries
npm install -g node-gyp
# Install eclib, you will need admin rights to install the libraries
npm install eclib --save
```
That's all!

### Usage
```node
// ES5
var eclib = require('eclib');

var Eclib = new eclib(opts);
Eclib.init();
```
See the [API documentation](API.md) for a more detailed explanation.

### License
eclib is distributed under the terms of the [BSD license](LICENSE).

[circle]: https://circleci.com/gh/scality/eclib.svg?&style=shield&circle-token=2f7b8c11e6dcb9327f1d5b09633fdf59<PASSWORD>
[npm]: https://www.npmjs.com/package/eclib
[npm version]: https://img.shields.io/npm/v/eclib.svg
[liberasure]: https://bitbucket.org/tsg-/liberasurecode
<commit_msg>docs(README): update install and usage steps<commit_after># eclib - Bindings for liberasurecode

[![Circle CI][circle]](https://circleci.com/gh/scality/eclib)
[![npm version][npm version]](https://www.npmjs.com/package/eclib)

eclib is a set of NodeJS bindings for [liberasurecode][liberasure]
and its backends.

### Installation

```sh
# We rely on node-gyp to build our binaries
npm install -g node-gyp

# Install eclib
npm install eclib --save

# We link to the libraries we installed earlier
# On Linux
LD_LIBRARY_PATH=node_modules/eclib/libs/lib ./your_script
# On OSX
DYLD_LIBRARY_PATH=node_modules/eclib/libs/lib ./your_script
# You may export that environment variable for ease of use.
```
That's all!

### Usage
```node
// ES5
var eclib = require('eclib');

var Eclib = new eclib(opts);
Eclib.init();
```
See the [API documentation](API.md) for a more detailed explanation.

### License
eclib is distributed under the terms of the [BSD license](LICENSE).

[circle]: https://circleci.com/gh/scality/eclib.svg?&style=shield&circle-token=<KEY>
[npm]: https://www.npmjs.com/package/eclib
[npm version]: https://img.shields.io/npm/v/eclib.svg
[liberasure]: https://bitbucket.org/tsg-/liberasurecode

{'fraction_non_alphanumeric': 0.14479025710419485, 'fraction_numerical': 0.009472259810554804, 'mean_word_length': 4.994594594594594, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 12, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '271530', 'n_tokens_mistral': 849, 'n_tokens_neox': 762, 'n_words': 208}