<commit_before># Cherrytree

[![build status](https://www.codeship.io/projects/aa5e37b0-aeb1-0131-dd5f-06fd12e6a611/status)](https://codeship.com/projects/19734)

Cherrytree is a flexible hierarchical client side router. Cherrytree translates every URL change to a transition object and a list of matching routes. You then apply a middleware function to translate the transition data into the desired state of your application.


# Installation

You can get cherrytree from npm - it supports both AMD and CJS.

    $ npm install --save cherrytree

In a CJS environment, simply require it as usual, the dependencies will be loaded from npm

    require('cherrytree')

In an AMD environment, require the standalone UMD build - this version has all of the dependencies bundled

    require('cherrytree/standalone')

# Usage

```js
var cherrytree = require('cherrytree')

// create the router
var router = cherrytree()

// provide your route map<commit_msg>Update README with a command that installs the alpha version<commit_after># Cherrytree

[![build status](https://www.codeship.io/projects/aa5e37b0-aeb1-0131-dd5f-06fd12e6a611/status)](https://codeship.com/projects/19734)

Cherrytree is a flexible hierarchical client side router. Cherrytree translates every URL change to a transition object and a list of matching routes. You then apply a middleware function to translate the transition data into the desired state of your application.


# Installation

You can get cherrytree from npm - it supports both AMD and CJS.

    $ npm install --save cherrytree@latest

In a CJS environment, simply require it as usual, the dependencies will be loaded from npm

    require('cherrytree')

In an AMD environment, require the standalone UMD build - this version has all of the dependencies bundled

    require('cherrytree/standalone')

# Usage

```js
var cherrytree = require('cherrytree')

// create the router
var router = cherrytree()

// provide your route map
{'fraction_non_alphanumeric': 0.07091836734693878, 'fraction_numerical': 0.02346938775510204, 'mean_word_length': 4.447222222222222, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 2, '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': '2419214', 'n_tokens_mistral': 582, 'n_tokens_neox': 515, 'n_words': 232}