Update README.md

Added docs on the two public functions.
Added some todos.
Merge pull request #3 from cclauss/patch-3

Update README.md