```{include} README.md
```

## Script Documentation
This file performs the partner matching algorithm. `get_words()` and 
`get_weight` are helper functions; `match()` is the main function which runs 
the algorithm.

```{eval-rst}
.. automodule:: partnermatcher.main
    :members:
```