<commit_before>Karmacracy API Javascript
=========================

[![Build Status](https://secure.travis-ci.org/jorgecasar/karmacracy-javascript-api.svg?branch=master)](http://travis-ci.org/jorgecasar/karmacracy-javascript-api)
[![Dependency Status](https://david-dm.org/jorgecasar/karmacracy-javascript-api.svg?theme=shields.io)](https://david-dm.org/jorgecasar/karmacracy-javascript-api)
[![devDependency Status](https://david-dm.org/jorgecasar/karmacracy-javascript-api/dev-status.svg?theme=shields.io)](https://david-dm.org/jorgecasar/karmacracy-javascript-api#info=devDependencies)

A Javascript wrapper for Karmacracy API. You can check the [official documentation](http://karmacracy.com/sections/api/documentation/api-documentation-index.php)

If you want to try the tool, here you are an [invitation](http://kcy.me/n6lp)

# Installation

You can use it in client-side and also in server-side

## Client-side

You can add it as bower dependency:

```bower install --save karmacracy-javascript-api```

## Server-side

You can install it using npm:

```npm install --save karmacracy-javascript-api```


# Initialize
Before start to develop an app or web using Karmacracy you need an [API_key](http://karmacracy.com/sections/api/key/introduction.php). 

## Runing Karmacracy API in the Client
```Javascript<commit_msg>Added Package Quality badge<commit_after>Karmacracy API Javascript
=========================
[![Package Quality](http://npm.packagequality.com/badge/karmacracy-javascript-api.png)](http://packagequality.com/#?package=karmacracy-javascript-api)
[![Build Status](https://secure.travis-ci.org/jorgecasar/karmacracy-javascript-api.svg?branch=master)](http://travis-ci.org/jorgecasar/karmacracy-javascript-api)
[![Dependency Status](https://david-dm.org/jorgecasar/karmacracy-javascript-api.svg?theme=shields.io)](https://david-dm.org/jorgecasar/karmacracy-javascript-api)
[![devDependency Status](https://david-dm.org/jorgecasar/karmacracy-javascript-api/dev-status.svg?theme=shields.io)](https://david-dm.org/jorgecasar/karmacracy-javascript-api#info=devDependencies)

A Javascript wrapper for Karmacracy API. You can check the [official documentation](http://karmacracy.com/sections/api/documentation/api-documentation-index.php)

If you want to try the tool, here you are an [invitation](http://kcy.me/n6lp)

# Installation

You can use it in client-side and also in server-side

## Client-side

You can add it as bower dependency:

```bower install --save karmacracy-javascript-api```

## Server-side

You can install it using npm:

```npm install --save karmacracy-javascript-api```


# Initialize
Before start to develop an app or web using Karmacracy you need an [API_key](http://karmacracy.com/sections/api/key/introduction.php). 

## Runing Karmacracy API in the Client
```Javascript
{'fraction_non_alphanumeric': 0.15398293029871976, 'fraction_numerical': 0.0007112375533428165, 'mean_word_length': 5.665876777251185, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 10, 'lorem ipsum': 0, 'www.': 0, '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': '4833424', 'n_tokens_mistral': 994, 'n_tokens_neox': 912, 'n_words': 182}