formatted api outline, rename it to readme.md