public api and notes about it in the readme