<commit_before>TODO Tracker
============
<!--
TODO: Fill in a description of what the TODO tracker is.
TODO: Fill in a list of example use cases we want to support.
-->
<commit_msg>first pass of README.md<commit_after>TODO Tracker
============
<!--
TODO: Add more use cases we want to support.
-->
TODO tracks is a tool to let users get a handle on the various TODOs they or
their teammate have added over time. This allows people to track progress by
examining the TODOs remaining.

The tool will examine all the branches, local and remote and process the TODOs
in the different revisions and present them to the user. 

Use cases:
- Examine when a TODO was added, removed, who added.
- Hierarchy of TODOs, that is a higher level TODO was replaced with smaller
  scoped TODOs.

{'fraction_non_alphanumeric': 0.08097686375321336, 'fraction_numerical': 0.0, 'mean_word_length': 3.961783439490446, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, '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': '4239782', 'n_tokens_mistral': 215, 'n_tokens_neox': 208, 'n_words': 124}