updated the readme to include the to new public methods