add readme and a docstring