<commit_before>**nani** is a Python 3 script that provides an information overview for a given command line tool.

Requirements
============

To run nani, you will need [docopt][].

[docopt]: http://docopt.org/ (docopt)

Usage
=====

Actual functionality is to be added.
<commit_msg>Add basic usage instructions to readme<commit_after>**nani** is a Python 3 script that provides an information overview for a given command line tool.

Requirements
============

To run nani, you will need [docopt][].

[docopt]: http://docopt.org/ (docopt)

Usage
=====

It is recommended that you move `nani.py` to your [`PATH`][PATH] and rename it to `nani`. Then, call `nani` from the command line, with the command you want to learn more about as its argument. For example:

    nani nano

[PATH]: http://en.wikipedia.org/wiki/PATH_(variable) (Wikipedia: PATH (variable))

{'fraction_non_alphanumeric': 0.13736903376018628, 'fraction_numerical': 0.002328288707799767, 'mean_word_length': 4.548387096774194, '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': '3884442', 'n_tokens_mistral': 262, 'n_tokens_neox': 252, 'n_words': 112}