cleaning up private functions, and readme file