<commit_before>
# Backbone.Facetr

VERSION 0.2.1

### <a name="contents"></a> CONTENTS

* [INTRODUCTION](#introduction)
* [INSTALLATION](#installation)
* [BASIC USAGE](#basic-usage)
* [DOT NOTATION](#dot-notation)
* [API REFERENCE](#api-reference)
* [EXAMPLES](#examples)
* [LICENSE](#license)

### <a name="introduction"></a> INTRODUCTION

Backbone.Facetr is a plugin which enables filtering of Backbone collections through facets, using an elegant API and with fast performance time.

It works flawlessly up to 2500 items; computation starts getting slower with 5000 - 10000 items. This is however an 
early version; optimizations may improve performance in future realeases.

If you decide to use Facetr on one of your projects, contact us, we would be glad to add the link to your project in the [examples](#examples) section.


### <a name="installation"></a> INSTALLATION

	<!DOCTYPE html>
	<html>
		....

		<!-- include Backbone.Facetr dependencies -->
		<script src="js/lib/underscore.js"></script>
		<script src="js/lib/backbone.js"></script>

		<!-- include Backbone.Facetr code --><commit_msg>fixed error in readme<commit_after>
# Backbone.Facetr

VERSION 0.2.1

### <a name="contents"></a> CONTENTS

* [INTRODUCTION](#introduction)
* [INSTALLATION](#installation)
* [BASIC USAGE](#basic-usage)
* [DOT NOTATION](#dot-notation)
* [API REFERENCE](#api-reference)
* [EXAMPLES](#examples)
* [LICENSE](#license)

### <a name="introduction"></a> INTRODUCTION

Backbone.Facetr is a plugin which enables filtering of Backbone collections through facets, using an elegant API and with fast performance time.

It works flawlessly up to 2500 items; computation starts getting slower with 5000 - 10000 items. This is however an 
early version; optimizations may improve performance in future realeases.

If you decide to use Facetr in one of your projects, contact us, we would be glad to add the link to your project in the [examples](#examples) section.


### <a name="installation"></a> INSTALLATION

	<!DOCTYPE html>
	<html>
		....

		<!-- include Backbone.Facetr dependencies -->
		<script src="js/lib/underscore.js"></script>
		<script src="js/lib/backbone.js"></script>

		<!-- include Backbone.Facetr code -->
{'fraction_non_alphanumeric': 0.13357400722021662, 'fraction_numerical': 0.01444043321299639, 'mean_word_length': 4.743523316062176, 'pattern_counts': {'":': 0, '<': 31, '<?xml version=': 0, '>': 31, 'https://': 0, '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': '6657851', 'n_tokens_mistral': 733, 'n_tokens_neox': 632, 'n_words': 229}