updated the readme to include public methods