<commit_before># Introduction to pucks

TODO: write [great documentation](http://jacobian.org/writing/great-documentation/what-to-write/)<commit_msg>Changed doc/intro to point to the readme.<commit_after># Pucks documentation

All of the pucks documentation is currently in the [ReadMe file] (https://github.com/lspector/pucks/blob/master/README.md).
{'fraction_non_alphanumeric': 0.11714285714285715, 'fraction_numerical': 0.0, 'mean_word_length': 5.75, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 1, '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': '3248686', 'n_tokens_mistral': 110, 'n_tokens_neox': 103, 'n_words': 28}