updated readme.md with method outline