This package has non-trivial functionality and needs much more documentation than a shallow `README.md`.