[x] I have written unit tests or justified all instances of #pragma: no cover; in the case of a bugfix, a new test that breaks as a result of the bug has been added
[x] My code contains relevant comments and necessary documentation for future maintainers; the change is reflected in applicable demos/tutorials (with output cleared!) and added/updated docstrings use the NumPy docstring format
[x] Any breaking changes, described above, are accompanied by backwards compatibility and deprecation warnings
Basic front page readme with links to the main repository
Closes #14
Code Quality
#pragma: no cover; in the case of a bugfix, a new test that breaks as a result of the bug has been added