add readme documenting the API