<commit_before>rest-factory.js
===========
[![Build Status](https://travis-ci.org/TrueRest/rest-facotry.js.svg?branch=master)](https://travis-ci.org/TrueRest/rest-facotry.js)

Development application for a Bower componenet

A rest factory for Javascript modules.<commit_msg>readme update<commit_after>rest-factory.js
===========
[![Build Status](https://travis-ci.org/TrueRest/rest-facotry.js.svg?branch=master)](https://travis-ci.org/TrueRest/rest-facotry.js)


# Usage

**(1)** Install with bower.
```
bower install rest-facotry
```

**Note**: The usage section is not ready yet.

# Contributing
To contribute you need to have [NodeJS](https://nodejs.org/en/) and [GruntJS](http://gruntjs.com/) previously installed.

**(1)** Download the repository
```
git clone https://github.com/TrueRest/rest-factory.js.git
```

**(2)** Install all the node dependencies
```
npm install
```

**(3)** Install all the bower dependencies
```
bower install
```

### Documentation
**(1)** To generate the code documentation you need to run the following command.
```
grunt doc
```

**(2)** Go to the folder `/docs` and open `index.html` in same browser.
{'fraction_non_alphanumeric': 0.18365553602811951, 'fraction_numerical': 0.005272407732864675, 'mean_word_length': 5.058510638297872, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5668281', 'n_tokens_mistral': 387, 'n_tokens_neox': 358, 'n_words': 97}