add yard docs. fix readme