updated readme
added docstrings