add a README and clean up some methods