updates readme.md with planned API