<commit_before>[![NPM version](https://img.shields.io/npm/v/perflint.svg?style=flat-square)](https://www.npmjs.com/package/perflint)
[![Build Status](https://travis-ci.org/perflint/perflint.svg?branch=master)](https://travis-ci.org/perflint/perflint)
[![Coverage Status](https://coveralls.io/repos/github/perflint/perflint/badge.svg?branch=master)](https://coveralls.io/github/perflint/perflint?branch=master)



# ![PerfLint](https://cloud.githubusercontent.com/assets/367517/13446841/aa0aed32-e00e-11e5-8ca3-f88ec87ce4ae.png)

PerfLint is a tool to identify unexpected performance levels of a Website, using [WebPageTest](http://www.webpagetest.org/) to obtain results.

## Installation

You can install PerfLint using `npm`:
```shell
npm install -g perflint
```<commit_msg>Add documentation links to README<commit_after>[![NPM version](https://img.shields.io/npm/v/perflint.svg?style=flat-square)](https://www.npmjs.com/package/perflint)
[![Build Status](https://travis-ci.org/perflint/perflint.svg?branch=master)](https://travis-ci.org/perflint/perflint)
[![Coverage Status](https://coveralls.io/repos/github/perflint/perflint/badge.svg?branch=master)](https://coveralls.io/github/perflint/perflint?branch=master)



# ![PerfLint](https://cloud.githubusercontent.com/assets/367517/13446841/aa0aed32-e00e-11e5-8ca3-f88ec87ce4ae.png)

[Documentation](https://perflint.readme.io/docs) | [Configuring](https://perflint.readme.io/docs/configuring-perflint) | [Rules](https://perflint.readme.io/docs/rules)

PerfLint is a tool to identify unexpected performance levels of a Website, using [WebPageTest](http://www.webpagetest.org/) to obtain results.

## Installation

You can install PerfLint using `npm`:
```shell
npm install -g perflint
```
{'fraction_non_alphanumeric': 0.17059161401493395, 'fraction_numerical': 0.03331418724870764, 'mean_word_length': 6.1687242798353905, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 17, 'lorem ipsum': 0, 'www.': 4, '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': '1284090', 'n_tokens_mistral': 693, 'n_tokens_neox': 636, 'n_words': 79}