It sounds like your module is similar to Curses, which is a thin wrapper around curses(3). But even though it's only a thin wrapper, my experience of using the Perl view of the library is mostly frustrating with the scarcity of docs.
in reply to On providing documentation with your modules
I was similarly annoyed at the initial documentation for Tk, which again, was just a thin wrapper around the Tk library. It's gotten
a lot better over time, because the documentation has been made more
"native", although often only by text-wrangling the Tk lib
docs in a consistent way.
Oh yeah, and I'm still annoyed at Mac::Glue, which requires me to understand all of AppleScript, most of OSA, and then some weirdnesses that are "obvious" for the Perl-OSA layer.
So please. anything you can give in the way of examples of each
invocation, careful descriptions of the differences and limitations, and known
gotchas, would all be most appreciated. Understand that people
want concepts, structure, and examples. While the original docs for the original lib may provide concepts and some structure, they do not provide
Perl-native structure or examples, and that's what you should fill in.