adjusted readme doc to show options and public functions as they currently stand