update readme with api comments