updated the readme. Edited some types around some functions