How to

How are we supposed to use this package?

The readme doesn't make sense (bad formatting and no clear link between the package and the objects/methods used) and there are no examples.
Would it be possible to do that?
