updated readme and docblocks