<commit_before># DRAFT: pubfood

[![npm version](https://badge.fury.io/js/pubfood.svg)](https://badge.fury.io/js/pubfood)
[![Build Status](https://travis-ci.org/pubfood/pubfood.svg?branch=master)](https://travis-ci.org/pubfood/pubfood)


A browser client header bidding JavaScript library.

# What is header bidding?

![Header Bidding Overview](doc/header-bidding-overview.png?raw=true "Header Bidding Overview")

It's what we (YB) do; on pageview:

- Publisher site code asks all partners, Yieldbot included, if we have an ad that meets the quality and performance of the page/slot;
- The Yieldbot and other platforms answer with a y/n:
    - `If y: the CPM offer is provided to the publisher ad server`
- The publisher ad server has the ultimate decision which partner "wins" the impression
    - `The winner may depend on other business rules defined in the publisher ad server; not just the CPM bid`

# Architecture Overview

![Architecture Overview - Requests](doc/pubfood-api-flow-requests.png?raw=true "Architecture Overview - Requests")
![Architecture Overview - Creative](doc/pubfood-api-flow-creative.png?raw=true "Architecture Overview - Creative")
![Architecture Overview - Report](doc/pubfood-api-flow-report.png?raw=true "Architecture Overview - Report")

# Design Models

## Auction State
![Auction State](doc/pubfood-bid-slot.png?raw=true "Internal Auction State")

# Build Tasks

## Build

- `npm start`

## Test

- `npm run test`

## Build Output

- `build/pubfood.js`
- `build/pubfood.min.js`
<commit_msg>remove vendor references from readme.<commit_after># DRAFT: pubfood

[![npm version](https://badge.fury.io/js/pubfood.svg)](https://badge.fury.io/js/pubfood)
[![Build Status](https://travis-ci.org/pubfood/pubfood.svg?branch=master)](https://travis-ci.org/pubfood/pubfood)

A browser client header bidding JavaScript library.

# Architecture Overview

![Architecture Overview - Requests](doc/pubfood-api-flow-requests.png?raw=true "Architecture Overview - Requests")
![Architecture Overview - Creative](doc/pubfood-api-flow-creative.png?raw=true "Architecture Overview - Creative")
![Architecture Overview - Report](doc/pubfood-api-flow-report.png?raw=true "Architecture Overview - Report")

# Build Tasks

## Build

- `npm start`

## Test

- `npm run test`

## Build Output

- `build/pubfood.js`
- `build/pubfood.min.js`

{'fraction_non_alphanumeric': 0.13390191897654585, 'fraction_numerical': 0.0, 'mean_word_length': 4.792592592592593, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 8, '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': '994524', 'n_tokens_mistral': 786, 'n_tokens_neox': 742, 'n_words': 199}