move the comments at the top of the module to the README