<commit_before><commit_msg>Started on README.md<commit_after># Exhibit

## Evidence based testing

Writing individual assertions on large data structures can be error-prone, brittle and, most importantly, boring.

If you have known-good data that can be deterministically reproduced you could instead capture it as evidence.

For example, you could test your API endpoints
    
    package endpoint_test

    import (
        "testing"
        . "bitbucket.org/toshafanasiev/exhibit"
    )

    func TestYourAPIEndpoints(t *testing.T) {
        
        var payload []byte = // get this from somewhere

        Exhibit{t}.A(JSON(payload))
    }

When you run `go test` this call to Exhibit will look for a file in your package directory called `endpoint_test.TestYourAPIEndpoints.exhibit-a.json` and compare the contents to your payload (once they've been pretty-printed).

If that file doesn't exist or the contents differ, the test fails so you should commit that file as evidence.

## Workflow

Does this mean I have to create all these files by hand?
{'fraction_non_alphanumeric': 0.061669829222011384, 'fraction_numerical': 0.0, 'mean_word_length': 3.5278969957081543, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, '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': '3121023', 'n_tokens_mistral': 290, 'n_tokens_neox': 274, 'n_words': 127}