small readability changes to the code and added notes of what needs to be done to the readme