changes to the api and readme