updated readme and added some method documentation