Similar to the openrouteservice backend docs at https://giscience.github.io/openrouteservice/, it would be more user-friendly and easier if documentation was a github page and lived in a docs folder in the main repo.
A lot of the information in the README could then also move to the docs and get linked from the README.