updating readme with some api notes