<commit_before># ![Carpet.js Icon](http://mgachowski.pl/carpetjs.svg) Carpet.js

<small>project icon: Rug by Factorio.us collective from The Noun Project</small>

Master: [![Build Status](https://travis-ci.org/mateuszgachowski/Carpet.js.svg?branch=master)](https://travis-ci.org/mateuszgachowski/Carpet.js) Develop: [![Build Status](https://travis-ci.org/mateuszgachowski/Carpet.js.svg?branch=develop)](https://travis-ci.org/mateuszgachowski/Carpet.js)

# Features

- Lightweight: Minified: 2.2K, Minified & Gzipped: < 1K
- Easy and Module based
- Easily extendable by components


# Framework Usage

## Installation

```
bower install carpet
```

or download the compressed file [from here](https://github.com/mateuszgachowski/Carpet.js/blob/master/dist/carpet.min.js)

## Minimal application

Minimal application will not do anything until you define some modules.

Example:

```html
<!doctype html>
<html><commit_msg>new: browser support added to readme file<commit_after># ![Carpet.js Icon](http://mgachowski.pl/carpetjs.svg) Carpet.js

<small>project icon: Rug by Factorio.us collective from The Noun Project</small>

Master: [![Build Status](https://travis-ci.org/mateuszgachowski/Carpet.js.svg?branch=master)](https://travis-ci.org/mateuszgachowski/Carpet.js) Develop: [![Build Status](https://travis-ci.org/mateuszgachowski/Carpet.js.svg?branch=develop)](https://travis-ci.org/mateuszgachowski/Carpet.js)

# Features

- Lightweight: Minified: 2.2K, Minified & Gzipped: < 1K
- Easy and Module based
- Easily extendable by components

**Browser Support (tested)**

- IE 9.0.0 (Windows Vista)
- IE 10.0.0 (Windows 8)
- IE 11.0.0 (Windows 8.1)
- Firefox 33.0.0 (Windows 8)
- Safari 8.0.0 (Mac OS X 10.10)
- Chrome 39.0.2171 (Mac OS X 10.10.0)



# Framework Usage

## Installation

```
bower install carpet
```

or download the compressed file [from here](https://github.com/mateuszgachowski/Carpet.js/blob/master/dist/carpet.min.js)

## Minimal application

Minimal application will not do anything until you define some modules.

Example:

```html
<!doctype html>
<html>
{'fraction_non_alphanumeric': 0.14595375722543352, 'fraction_numerical': 0.02119460500963391, 'mean_word_length': 4.7855153203342615, 'pattern_counts': {'":': 0, '<': 13, '<?xml version=': 0, '>': 11, 'https://': 10, 'lorem ipsum': 0, 'www.': 0, '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': '3644383', 'n_tokens_mistral': 790, 'n_tokens_neox': 737, 'n_words': 168}