<commit_before>node-flipr-yaml
============

# Progress Notes
* Need to rewrite tests

This project is part of the [flipr family](https://github.com/godaddy/node-flipr).

node-flipr-yaml is a [flipr source](http://todoaddurl) for retrieving flipr configuration data from yaml files.

![node-flipr](/flipr.png?raw=true "node-flipr")

# How does it work?
The examples below are just showing you how to create the flipr yaml source.  A source by itself isn't very useful.  You'll still need to give the source to flipr, so that it can use it to do awesome things.  See the [flipr documentation](http://todoaddurl) for how to use a source.

## Here's the simplest example:
```yaml
---
# Here's a basic YAML config file. Assume it exists at config/simple.yaml<commit_msg>Updated readme notes<commit_after>node-flipr-yaml
============

# Progress Notes
* Need to update urls once we setup repos

This project is part of the [flipr family](https://github.com/godaddy/node-flipr).

node-flipr-yaml is a [flipr source](http://todoaddurl) for retrieving flipr configuration data from yaml files.

![node-flipr](/flipr.png?raw=true "node-flipr")

# How does it work?
The examples below are just showing you how to create the flipr yaml source.  A source by itself isn't very useful.  You'll still need to give the source to flipr, so that it can use it to do awesome things.  See the [flipr documentation](http://todoaddurl) for how to use a source.

## Here's the simplest example:
```yaml
---
# Here's a basic YAML config file. Assume it exists at config/simple.yaml
{'fraction_non_alphanumeric': 0.10918432883750803, 'fraction_numerical': 0.0, 'mean_word_length': 4.245791245791246, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, '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': '436114', 'n_tokens_mistral': 497, 'n_tokens_neox': 460, 'n_words': 205}