update the README for public use