updates readme and code comments