<commit_before>### Brando

[![NPM VERSION](http://img.shields.io/npm/v/brando.svg)](https://www.npmjs.org/package/brando)
[![CODACY BADGE](https://img.shields.io/codacy/b18ed7d95b0a4707a0ff7b88b30d3def.svg)](https://www.codacy.com/public/44gatti/brando)
[![CODECLIMATE-TEST-COVERAGE](https://codeclimate.com/github/rootslab/brando/badges/coverage.svg)](https://codeclimate.com/github/rootslab/brando)
[![LICENSE](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/rootslab/brando#mit-license)

[![TRAVIS CI BUILD](http://img.shields.io/travis/rootslab/brando.svg)](http://travis-ci.org/rootslab/brando)
[![BUILD STATUS](http://img.shields.io/david/rootslab/brando.svg)](https://david-dm.org/rootslab/brando)
[![DEVDEPENDENCY STATUS](http://img.shields.io/david/dev/rootslab/brando.svg)](https://david-dm.org/rootslab/brando#info=devDependencies)

[![status](https://sourcegraph.com/api/repos/github.com/rootslab/brando/.badges/status.png)](https://sourcegraph.com/github.com/rootslab/brando)
[![views](https://sourcegraph.com/api/repos/github.com/rootslab/brando/.counters/views.png)](https://sourcegraph.com/github.com/rootslab/brando)
[![views 24h](https://sourcegraph.com/api/repos/github.com/rootslab/brando/.counters/views-24h.png)](https://sourcegraph.com/github.com/rootslab/brando)
[![NPM DOWNLOADS](http://img.shields.io/npm/dm/brando.svg)](http://npm-stat.com/charts.html?package=brando)
[![GITTIP](http://img.shields.io/gittip/rootslab.svg)](https://www.gittip.com/rootslab/)

[![NPM GRAPH1](https://nodei.co/npm-dl/brando.png)](https://nodei.co/npm/brando/)

[![NPM GRAPH2](https://nodei.co/npm/brando.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/brando/)

> __Brando__.

###Install

```bash
$ npm install brando [-g]
```

> __require__:

```javascript
var Brando  = require( 'brando' );
```
###Run Tests

> __to run all test files, install devDependecies:__

```bash
 $ cd brando/
 # install or update devDependecies 
 $ npm install --dev
 # run tests
 $ npm test
```
> __to execute a single test file simply do__:

```bash
 $ node test/file-name.js
```

###Methods

> Arguments within [ ] are optional.

```javascript
/*
 * A simple factory method, it returns a Sequence EventEmitter,
 * for producing the requested random (Buffer) sequence/permutation.
 *
 * NOTE:
 * - max allowed value for items is 2^(16) - 1 (65535), see comments in the code.
 * - max value for range is 2^32, or 4-byte numbers.
 * - unlimitied repetitions for items are enabled for default (+Infinity),
 *   otherwise use repeat === 1 to produce a full or a partial range permutation.
 *   
 */
Brando#get : function ( Number items, Number range [, Number repeat ] ) : Sequence

/*
 * Print some informational numbers about a particular sequence or permutation,
 * without creating anything.
 */
Brando#sham : function ( Number items, Number range [, Number repeat ] ) : Sequence

/*
 * Like #get, but it returns a Transform stream.<commit_msg>fixed Readme.. On branch master modified:   Readme.md<commit_after>### Brando

[![NPM VERSION](http://img.shields.io/npm/v/brando.svg)](https://www.npmjs.org/package/brando)
[![CODACY BADGE](https://img.shields.io/codacy/b18ed7d95b0a4707a0ff7b88b30d3def.svg)](https://www.codacy.com/public/44gatti/brando)
[![CODECLIMATE-TEST-COVERAGE](https://codeclimate.com/github/rootslab/brando/badges/coverage.svg)](https://codeclimate.com/github/rootslab/brando)
[![LICENSE](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/rootslab/brando#mit-license)

[![TRAVIS CI BUILD](http://img.shields.io/travis/rootslab/brando.svg)](http://travis-ci.org/rootslab/brando)
[![BUILD STATUS](http://img.shields.io/david/rootslab/brando.svg)](https://david-dm.org/rootslab/brando)
[![DEVDEPENDENCY STATUS](http://img.shields.io/david/dev/rootslab/brando.svg)](https://david-dm.org/rootslab/brando#info=devDependencies)

[![status](https://sourcegraph.com/api/repos/github.com/rootslab/brando/.badges/status.png)](https://sourcegraph.com/github.com/rootslab/brando)
[![views](https://sourcegraph.com/api/repos/github.com/rootslab/brando/.counters/views.png)](https://sourcegraph.com/github.com/rootslab/brando)
[![views 24h](https://sourcegraph.com/api/repos/github.com/rootslab/brando/.counters/views-24h.png)](https://sourcegraph.com/github.com/rootslab/brando)
[![NPM DOWNLOADS](http://img.shields.io/npm/dm/brando.svg)](http://npm-stat.com/charts.html?package=brando)
[![GITTIP](http://img.shields.io/gittip/rootslab.svg)](https://www.gittip.com/rootslab/)

[![NPM GRAPH1](https://nodei.co/npm-dl/brando.png)](https://nodei.co/npm/brando/)

[![NPM GRAPH2](https://nodei.co/npm/brando.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/brando/)

> __Brando__.

###Install

```bash
$ npm install brando [-g]
```

> __require__:

```javascript
var Brando  = require( 'brando' );
```
###Run Tests

> __to run all test files, install devDependecies:__

```bash
 $ cd brando/
 # install or update devDependecies 
 $ npm install --dev
 # run tests
 $ npm test
```
> __to execute a single test file simply do__:

```bash
 $ node test/file-name.js
```

###Methods

> Arguments within [ ] are optional.

```javascript
/*
 * A simple factory method, it returns a Sequence EventEmitter,
 * for producing the requested random (Buffer) sequence/permutation.
 *
 * NOTE:
 * - max allowed value for items and range is 2^(32) - 1, or 4-byte numbers.
 * - unlimitied repetitions for items are enabled for default (+Infinity),
 *   otherwise use repeat === 1 to produce a full or a partial range permutation.
 *   
 */
Brando#get : function ( Number items, Number range [, Number repeat ] ) : Sequence

/*
 * Print some informational numbers about a particular sequence or permutation,
 * without creating anything.
 */
Brando#sham : function ( Number items, Number range [, Number repeat ] ) : Sequence

/*
 * Like #get, but it returns a Transform stream.
{'fraction_non_alphanumeric': 0.17913717559824738, 'fraction_numerical': 0.011796427367711493, 'mean_word_length': 4.7232401157184185, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 13, 'https://': 38, 'lorem ipsum': 0, 'www.': 6, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1581838', 'n_tokens_mistral': 2279, 'n_tokens_neox': 2079, 'n_words': 355}