add readme and some docstrings in test suite